????
| Current Path : /opt/ant/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/ |
| Current File : //opt/ant/manual/api/org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Tue May 22 06:24:54 CEST 2012 -->
<title>DefaultNative2Ascii (Apache Ant API)</title>
<meta name="date" content="2012-05-22">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DefaultNative2Ascii (Apache Ant API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/KaffeNative2Ascii.html" title="class in org.apache.tools.ant.taskdefs.optional.native2ascii"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html" target="_top">Frames</a></li>
<li><a href="DefaultNative2Ascii.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.tools.ant.taskdefs.optional.native2ascii</div>
<h2 title="Class DefaultNative2Ascii" class="title">Class DefaultNative2Ascii</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.tools.ant.taskdefs.optional.native2ascii.DefaultNative2Ascii</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/Native2AsciiAdapter.html" title="interface in org.apache.tools.ant.taskdefs.optional.native2ascii">Native2AsciiAdapter</a></dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/KaffeNative2Ascii.html" title="class in org.apache.tools.ant.taskdefs.optional.native2ascii">KaffeNative2Ascii</a>, <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/SunNative2Ascii.html" title="class in org.apache.tools.ant.taskdefs.optional.native2ascii">SunNative2Ascii</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="strong">DefaultNative2Ascii</span>
extends java.lang.Object
implements <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/Native2AsciiAdapter.html" title="interface in org.apache.tools.ant.taskdefs.optional.native2ascii">Native2AsciiAdapter</a></pre>
<div class="block">encapsulates the handling common to diffent Native2Asciiadapter
implementations.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Ant 1.6.3</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html#DefaultNative2Ascii()">DefaultNative2Ascii</a></strong>()</code>
<div class="block">No-arg constructor.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html#addFiles(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.ProjectComponent, java.io.File, java.io.File)">addFiles</a></strong>(<a href="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</a> cmd,
<a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a> log,
java.io.File src,
java.io.File dest)</code>
<div class="block">Adds source and dest files to the command line.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html#convert(org.apache.tools.ant.taskdefs.optional.Native2Ascii, java.io.File, java.io.File)">convert</a></strong>(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/Native2Ascii.html" title="class in org.apache.tools.ant.taskdefs.optional">Native2Ascii</a> args,
java.io.File srcFile,
java.io.File destFile)</code>
<div class="block">Splits the task into setting up the command line switches</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected abstract boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html#run(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.ProjectComponent)">run</a></strong>(<a href="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</a> cmd,
<a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a> log)</code>
<div class="block">Executes the command.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html#setup(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.taskdefs.optional.Native2Ascii)">setup</a></strong>(<a href="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</a> cmd,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/Native2Ascii.html" title="class in org.apache.tools.ant.taskdefs.optional">Native2Ascii</a> args)</code>
<div class="block">Sets up the initial command line.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="DefaultNative2Ascii()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>DefaultNative2Ascii</h4>
<pre>public DefaultNative2Ascii()</pre>
<div class="block">No-arg constructor.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="convert(org.apache.tools.ant.taskdefs.optional.Native2Ascii, java.io.File, java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>convert</h4>
<pre>public final boolean convert(<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/Native2Ascii.html" title="class in org.apache.tools.ant.taskdefs.optional">Native2Ascii</a> args,
java.io.File srcFile,
java.io.File destFile)
throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Splits the task into setting up the command line switches</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/Native2AsciiAdapter.html#convert(org.apache.tools.ant.taskdefs.optional.Native2Ascii, java.io.File, java.io.File)">convert</a></code> in interface <code><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/Native2AsciiAdapter.html" title="interface in org.apache.tools.ant.taskdefs.optional.native2ascii">Native2AsciiAdapter</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>args</code> - the native 2 ascii arguments.</dd><dd><code>srcFile</code> - the source file.</dd><dd><code>destFile</code> - the destination file.</dd>
<dt><span class="strong">Returns:</span></dt><dd>run if the conversion was successful.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if there is a problem.
(delegated to <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html#setup(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.taskdefs.optional.Native2Ascii)"><code>setup</code></a>), adding the file names
(delegated to <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html#addFiles(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.ProjectComponent, java.io.File, java.io.File)"><code>addFiles</code></a>) and running the tool
(delegated to <a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html#run(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.ProjectComponent)"><code>run</code></a>).</dd></dl>
</li>
</ul>
<a name="setup(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.taskdefs.optional.Native2Ascii)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setup</h4>
<pre>protected void setup(<a href="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</a> cmd,
<a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/Native2Ascii.html" title="class in org.apache.tools.ant.taskdefs.optional">Native2Ascii</a> args)
throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Sets up the initial command line.
<p>only the -encoding argument and nested arg elements get
handled here.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - Command line to add to</dd><dd><code>args</code> - provides the user-setting and access to Ant's
logging system.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if there was a problem.</dd></dl>
</li>
</ul>
<a name="addFiles(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.ProjectComponent, java.io.File, java.io.File)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addFiles</h4>
<pre>protected void addFiles(<a href="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</a> cmd,
<a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a> log,
java.io.File src,
java.io.File dest)
throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Adds source and dest files to the command line.
<p>This implementation adds them without any leading
qualifiers, source first.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - Command line to add to</dd><dd><code>log</code> - provides access to Ant's logging system.</dd><dd><code>src</code> - the source file</dd><dd><code>dest</code> - the destination file</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if there was a problem.</dd></dl>
</li>
</ul>
<a name="run(org.apache.tools.ant.types.Commandline, org.apache.tools.ant.ProjectComponent)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>run</h4>
<pre>protected abstract boolean run(<a href="../../../../../../../org/apache/tools/ant/types/Commandline.html" title="class in org.apache.tools.ant.types">Commandline</a> cmd,
<a href="../../../../../../../org/apache/tools/ant/ProjectComponent.html" title="class in org.apache.tools.ant">ProjectComponent</a> log)
throws <a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></pre>
<div class="block">Executes the command.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cmd</code> - Command line to execute</dd><dd><code>log</code> - provides access to Ant's logging system.</dd>
<dt><span class="strong">Returns:</span></dt><dd>whether execution was successful</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../../../../../org/apache/tools/ant/BuildException.html" title="class in org.apache.tools.ant">BuildException</a></code> - if there was a problem.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>Prev Class</li>
<li><a href="../../../../../../../org/apache/tools/ant/taskdefs/optional/native2ascii/KaffeNative2Ascii.html" title="class in org.apache.tools.ant.taskdefs.optional.native2ascii"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?org/apache/tools/ant/taskdefs/optional/native2ascii/DefaultNative2Ascii.html" target="_top">Frames</a></li>
<li><a href="DefaultNative2Ascii.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>