| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.6.0_26) on Thu May 03 15:25:50 PDT 2012 --> |
| <META http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <TITLE> |
| BaseLinksBuilder (Apache Wink 1.2.0-incubating API) |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2012-05-03"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="BaseLinksBuilder (Apache Wink 1.2.0-incubating API)"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <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"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BaseLinksBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../../org/apache/wink/server/utils/LinkBuilders.html" title="interface in org.apache.wink.server.utils"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/wink/server/utils/BaseLinksBuilder.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BaseLinksBuilder.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.apache.wink.server.utils</FONT> |
| <BR> |
| Interface BaseLinksBuilder<T></H2> |
| <DL> |
| <DT><DT><B>Type Parameters:</B><DD><CODE>T</CODE> - the derived type of the links builder</DL> |
| <DL> |
| <DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../../org/apache/wink/server/utils/SingleLinkBuilder.html" title="interface in org.apache.wink.server.utils">SingleLinkBuilder</A>, <A HREF="../../../../../org/apache/wink/server/utils/SystemLinksBuilder.html" title="interface in org.apache.wink.server.utils">SystemLinksBuilder</A></DD> |
| </DL> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>BaseLinksBuilder<T></B></DL> |
| </PRE> |
| |
| <P> |
| Base interface for the the two types of link builders. |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/wink/server/utils/SingleLinkBuilder.html" title="interface in org.apache.wink.server.utils"><CODE>SingleLinkBuilder</CODE></A>, |
| <A HREF="../../../../../org/apache/wink/server/utils/SystemLinksBuilder.html" title="interface in org.apache.wink.server.utils"><CODE>SystemLinksBuilder</CODE></A></DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <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"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html#addAltParam(boolean)">addAltParam</A></B>(boolean addAltParam)</CODE> |
| |
| <BR> |
| Set whether the to automatically add to the generated links the "alt" |
| query parameter indicating the link type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html#baseUri(java.net.URI)">baseUri</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> base)</CODE> |
| |
| <BR> |
| Set the base uri for this builder.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../org/apache/wink/common/model/synd/SyndLink.html" title="class in org.apache.wink.common.model.synd">SyndLink</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html#build(java.util.List)">build</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../org/apache/wink/common/model/synd/SyndLink.html" title="class in org.apache.wink.common.model.synd">SyndLink</A>> out)</CODE> |
| |
| <BR> |
| Build the link(s) and add them to the provided list.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html#pathParam(java.lang.String, java.lang.String)">pathParam</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</CODE> |
| |
| <BR> |
| Set the value of a template path parameter to be used during the building |
| of the links.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html#queryParam(java.lang.String, java.lang.String)">queryParam</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</CODE> |
| |
| <BR> |
| Set the value of a query parameter to be added to the generated links</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html#relativeTo(java.net.URI)">relativeTo</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> relativeTo)</CODE> |
| |
| <BR> |
| Set the uri that the generated links will be relative to, if the |
| generation mode is relative uri's.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html#relativize(boolean)">relativize</A></B>(boolean relativize)</CODE> |
| |
| <BR> |
| Set whether the links should be generated absolute or relative, |
| overriding any configuration and request settings.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html#resource(java.lang.Class)">resource</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><?> resource)</CODE> |
| |
| <BR> |
| Set the resource class that the generated links should link to.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html#resource(java.lang.Object)">resource</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> resource)</CODE> |
| |
| <BR> |
| Set the resource instance that the generated links should link to.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html#subResource(java.lang.String)">subResource</A></B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> template)</CODE> |
| |
| <BR> |
| Set the sub-resource path that the generated links should link to, |
| relative to the resource set in the builder.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <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"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="resource(java.lang.Class)"><!-- --></A><H3> |
| resource</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A> <B>resource</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A><?> resource)</PRE> |
| <DL> |
| <DD>Set the resource class that the generated links should link to. If no |
| resource is set then the active resource is used. Setting the resource |
| clears any sub-resource path previously set. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>resource</CODE> - a resource class annotated with the |
| <CODE>Path</CODE> annotation |
| <DT><B>Returns:</B><DD>this links builder</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="resource(java.lang.Object)"><!-- --></A><H3> |
| resource</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A> <B>resource</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> resource)</PRE> |
| <DL> |
| <DD>Set the resource instance that the generated links should link to. If no |
| resource is set then the active resource is used. Setting the resource |
| clears any sub-resource path previously set. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>resource</CODE> - a resource instance, or null to use the current resource |
| <DT><B>Returns:</B><DD>this links builder</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="subResource(java.lang.String)"><!-- --></A><H3> |
| subResource</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A> <B>subResource</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> template)</PRE> |
| <DL> |
| <DD>Set the sub-resource path that the generated links should link to, |
| relative to the resource set in the builder. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>template</CODE> - the template path of the sub-resource |
| <DT><B>Returns:</B><DD>this links builder</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="baseUri(java.net.URI)"><!-- --></A><H3> |
| baseUri</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A> <B>baseUri</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> base)</PRE> |
| <DL> |
| <DD>Set the base uri for this builder. If not set, or if set to |
| <code>null</code>, then the base uri as obtained from |
| <CODE>UriInfo.getBaseUri()</CODE> is used. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>base</CODE> - the base uri for this builder, or null |
| <DT><B>Returns:</B><DD>this links builder</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="relativeTo(java.net.URI)"><!-- --></A><H3> |
| relativeTo</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A> <B>relativeTo</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/net/URI.html?is-external=true" title="class or interface in java.net">URI</A> relativeTo)</PRE> |
| <DL> |
| <DD>Set the uri that the generated links will be relative to, if the |
| generation mode is relative uri's. The uri being set must be absolute and |
| must be prefixed with the base uri set on this links builder. If not set, |
| or if set to <code>null</code>, then the generated links will be relative |
| to the path obtained from <CODE>UriInfo.getPath()</CODE>. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>relativeTo</CODE> - the relative uri for this builder, or null |
| <DT><B>Returns:</B><DD>this links builder</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="pathParam(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| pathParam</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A> <B>pathParam</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</PRE> |
| <DL> |
| <DD>Set the value of a template path parameter to be used during the building |
| of the links. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the path parameter<DD><CODE>value</CODE> - the value of the path parameter |
| <DT><B>Returns:</B><DD>this links builder</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="queryParam(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| queryParam</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A> <B>queryParam</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</PRE> |
| <DL> |
| <DD>Set the value of a query parameter to be added to the generated links |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the query parameter to add to the generated links<DD><CODE>value</CODE> - the value of the query parameter |
| <DT><B>Returns:</B><DD>this links builder</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="relativize(boolean)"><!-- --></A><H3> |
| relativize</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A> <B>relativize</B>(boolean relativize)</PRE> |
| <DL> |
| <DD>Set whether the links should be generated absolute or relative, |
| overriding any configuration and request settings. If this method is not |
| called, the behavior is taken from the value of the "relative-urls" query |
| parameter on the request. If the request does not have the query |
| parameter, the behavior is taken from the |
| <code>wink.defaultUrisRelative</code> configuration property. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>relativize</CODE> - <code>true</code> to produce relative links, |
| <code>false</code> to produce absolute links |
| <DT><B>Returns:</B><DD>this links builder</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="addAltParam(boolean)"><!-- --></A><H3> |
| addAltParam</H3> |
| <PRE> |
| <A HREF="../../../../../org/apache/wink/server/utils/BaseLinksBuilder.html" title="type parameter in BaseLinksBuilder">T</A> <B>addAltParam</B>(boolean addAltParam)</PRE> |
| <DL> |
| <DD>Set whether the to automatically add to the generated links the "alt" |
| query parameter indicating the link type. The "alt" query parameter will |
| never be added automatically in case if it was added manually. If this |
| method is not called, the default behavior is taken from the |
| <code>wink.addAltParam</code> configuration property. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>addAltParam</CODE> - <code>true</code> to add the "alt" parameter |
| <DT><B>Returns:</B><DD></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="build(java.util.List)"><!-- --></A><H3> |
| build</H3> |
| <PRE> |
| <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../org/apache/wink/common/model/synd/SyndLink.html" title="class in org.apache.wink.common.model.synd">SyndLink</A>> <B>build</B>(<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A><<A HREF="../../../../../org/apache/wink/common/model/synd/SyndLink.html" title="class in org.apache.wink.common.model.synd">SyndLink</A>> out)</PRE> |
| <DL> |
| <DD>Build the link(s) and add them to the provided list. The state of the |
| builder is not affected by this method. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>out</CODE> - the output list of links to add the generated link(s) to. If |
| the provided list is <code>null</code> then a new list is |
| created. |
| <DT><B>Returns:</B><DD>the provided (or new) output list.</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <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"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BaseLinksBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../../org/apache/wink/server/utils/LinkBuilders.html" title="interface in org.apache.wink.server.utils"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../index.html?org/apache/wink/server/utils/BaseLinksBuilder.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="BaseLinksBuilder.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| Copyright © 2009-2012 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. |
| </BODY> |
| </HTML> |