Edit C:\apache-ant-1.8.0\docs\manual\api\org\apache\tools\ant\property\ParseProperties.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

<HTML>
<HEAD>

<TITLE>
ParseProperties (Apache Ant API)
</TITLE>

<SCRIPT type="text/javascript">
function windowTitle()
{
 parent.document.title="ParseProperties (Apache Ant API)";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>

</HEAD>

<A NAME="navbar_top"></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2">
&nbsp;<A HREF="../../../../../org/apache/tools/ant/property/ParseNextProperty.html" title="interface in org.apache.tools.ant.property">PREV CLASS</A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/tools/ant/property/PropertyExpander.html" title="interface in org.apache.tools.ant.property">NEXT CLASS</A></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2">
 <A HREF="../../../../../index.html?org/apache/tools/ant/property/ParseProperties.html" target="_top">FRAMES</A> &nbsp;
&nbsp;<A HREF="ParseProperties.html" target="_top">NO FRAMES</A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
 
</SCRIPT>
<NOSCRIPT>
 <A HREF="../../../../../allclasses-noframe.html">All Classes</A>
</NOSCRIPT>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>

<HR>

<H2>

org.apache.tools.ant.property
 
Class ParseProperties</H2>
<PRE>
java.lang.Object
 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by ">org.apache.tools.ant.property.ParseProperties
</PRE>
<DL>
<DT>All Implemented Interfaces: <DD><A HREF="../../../../../org/apache/tools/ant/property/ParseNextProperty.html" title="interface in org.apache.tools.ant.property">ParseNextProperty</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public class ParseProperties<DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/apache/tools/ant/property/ParseNextProperty.html" title="interface in org.apache.tools.ant.property">ParseNextProperty</A></DL>
</PRE>

Parse properties using a collection of expanders.

<DL>
<DT>Since:</DT>
 <DD>Ant 1.8.0</DD>
</DL>
<HR>

<A NAME="constructor_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Constructor Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/property/ParseProperties.html#ParseProperties(org.apache.tools.ant.Project, java.util.Collection, org.apache.tools.ant.property.GetProperty)">ParseProperties</A>(<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
 java.util.Collection&nbsp;expanders,
 <A HREF="../../../../../org/apache/tools/ant/property/GetProperty.html" title="interface in org.apache.tools.ant.property">GetProperty</A>&nbsp;getProperty)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor with a getProperty.</TD>
</TR>
</TABLE>
&nbsp;

<A NAME="method_summary"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2">
Method Summary</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;boolean</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/property/ParseProperties.html#containsProperties(java.lang.String)">containsProperties</A>(java.lang.String&nbsp;value)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Learn whether a String contains replaceable properties.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A></CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/property/ParseProperties.html#getProject()">getProject</A>()</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the project.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.Object</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/property/ParseProperties.html#parseNextProperty(java.lang.String, java.text.ParsePosition)">parseNextProperty</A>(java.lang.String&nbsp;value,
 java.text.ParsePosition&nbsp;pos)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return any property that can be parsed from the specified position
 in the specified String.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%">
<CODE>&nbsp;java.lang.Object</CODE></TD>
<TD><CODE><A HREF="../../../../../org/apache/tools/ant/property/ParseProperties.html#parseProperties(java.lang.String)">parseProperties</A>(java.lang.String&nbsp;value)</CODE>

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Decode properties from a String representation.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left">Methods inherited from class java.lang.Object</TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;

<A NAME="constructor_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Constructor Detail</TH>
</TR>
</TABLE>

<A NAME="ParseProperties(org.apache.tools.ant.Project, java.util.Collection, org.apache.tools.ant.property.GetProperty)"></A><H3>
ParseProperties</H3>
<PRE>
public ParseProperties(<A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A>&nbsp;project,
 java.util.Collection&nbsp;expanders,
 <A HREF="../../../../../org/apache/tools/ant/property/GetProperty.html" title="interface in org.apache.tools.ant.property">GetProperty</A>&nbsp;getProperty)</PRE>
<DL>
<DD>Constructor with a getProperty.

<DL>
<DT>Parameters:<DD><CODE>project</CODE> - the current ant project.<DD><CODE>expanders</CODE> - a sequence of exapanders<DD><CODE>getProperty</CODE> - property resolver.</DL>
</DL>

<A NAME="method_detail"></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1">
Method Detail</TH>
</TR>
</TABLE>

<A NAME="getProject()"></A><H3>
getProject</H3>
<PRE>
public <A HREF="../../../../../org/apache/tools/ant/Project.html" title="class in org.apache.tools.ant">Project</A> getProject()</PRE>
<DL>
<DD>Get the project.

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/tools/ant/property/ParseNextProperty.html#getProject()">getProject</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/property/ParseNextProperty.html" title="interface in org.apache.tools.ant.property">ParseNextProperty</A></CODE></DL>
</DD>
<DD><DL>

<DT>Returns:<DD>the current ant project.</DL>
</DD>
</DL>
<HR>

<A NAME="parseProperties(java.lang.String)"></A><H3>
parseProperties</H3>
<PRE>
public java.lang.Object parseProperties(java.lang.String&nbsp;value)</PRE>
<DL>
<DD>Decode properties from a String representation.

<ul>

<li>This implementation starts parsing the <code>value</code>
 parameter (unsurprisingly) at the beginning and asks each
 <A HREF="../../../../../org/apache/tools/ant/property/PropertyExpander.html" title="interface in org.apache.tools.ant.property"><CODE>PropertyExpander</CODE></A> 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.</li>

<li>If the PropertyExpander returns <code>null</code> the
 method continues with the next PropertyExpander, otherwise it
 tries to look up the property's value using the configured
 <A HREF="../../../../../org/apache/tools/ant/property/GetProperty.html" title="interface in org.apache.tools.ant.property"><CODE>GetProperty</CODE></A> instance.</li>

<li>Once all PropertyExpanders have been consulted, the parse
 position is advanced by one character and the process repeated
 until <code>value</code> is exhausted.</li>

</ul>

If the entire contents of <code>value</code> resolves to a
 single property, the looked up property value is returned.
 Otherwise a String is returned that concatenates the
 non-property parts of <code>value</code> and the expanded
 values of the properties that have been found.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>value</CODE> - The string to be scanned for property references.
 May be <code>null</code>, in which case this
 method returns immediately with no effect.
<DT>Returns:<DD>the original string with the properties replaced, or
 <code>null</code> if the original string is <code>null</code>.</DL>
</DD>
</DL>
<HR>

<A NAME="containsProperties(java.lang.String)"></A><H3>
containsProperties</H3>
<PRE>
public boolean containsProperties(java.lang.String&nbsp;value)</PRE>
<DL>
<DD>Learn whether a String contains replaceable properties.

Uses the configured <A HREF="../../../../../org/apache/tools/ant/property/PropertyExpander.html" title="interface in org.apache.tools.ant.property"><CODE>PropertyExpanders</CODE></A> and scans through the string. Returns true
 as soon as any expander finds a property.

<DD><DL>
</DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>value</CODE> - the String to check.
<DT>Returns:<DD><code>true</code> if <code>value</code> contains property notation.</DL>
</DD>
</DL>
<HR>

<A NAME="parseNextProperty(java.lang.String, java.text.ParsePosition)"></A><H3>
parseNextProperty</H3>
<PRE>
public java.lang.Object parseNextProperty(java.lang.String&nbsp;value,
 java.text.ParsePosition&nbsp;pos)</PRE>
<DL>
<DD>Return any property that can be parsed from the specified position
 in the specified String.

Uses the configured <A HREF="../../../../../org/apache/tools/ant/property/PropertyExpander.html" title="interface in org.apache.tools.ant.property"><CODE>PropertyExpanders</CODE></A> and <A HREF="../../../../../org/apache/tools/ant/property/GetProperty.html" title="interface in org.apache.tools.ant.property"><CODE>GetProperty</CODE></A>
 instance .

<DD><DL>
<DT>Specified by:<DD><CODE><A HREF="../../../../../org/apache/tools/ant/property/ParseNextProperty.html#parseNextProperty(java.lang.String, java.text.ParsePosition)">parseNextProperty</A></CODE> in interface <CODE><A HREF="../../../../../org/apache/tools/ant/property/ParseNextProperty.html" title="interface in org.apache.tools.ant.property">ParseNextProperty</A></CODE></DL>
</DD>
<DD><DL>
<DT>Parameters:<DD><CODE>value</CODE> - String to parse<DD><CODE>pos</CODE> - ParsePosition
<DT>Returns:<DD>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.</DL>
</DD>
</DL>

<HR>

<A NAME="navbar_bottom"></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
 <TR ALIGN="center" VALIGN="top">
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html">Overview</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html">Package</A>&nbsp;</TD>
 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;Class&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html">Tree</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html">Deprecated</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html">Index</A>&nbsp;</TD>
 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html">Help</A>&nbsp;</TD>
 </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3>

</TD>
</TR>

</TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3">
 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></TD>
<TD VALIGN="top" CLASS="NavBarCell3">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>

<HR>

</BODY>
</HTML>

Ms-Dos/Windows Unix Write backup

jsp File Browser version 1.2 by www.vonloesch.de