mirror of
https://github.com/etesync/android
synced 2025-07-05 06:12:36 +00:00
332 lines
12 KiB
HTML
332 lines
12 KiB
HTML
<!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_37) on Mon Feb 18 20:39:44 EST 2013 -->
|
|
<TITLE>
|
|
Element
|
|
</TITLE>
|
|
|
|
<META NAME="date" CONTENT="2013-02-18">
|
|
|
|
<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="Element";
|
|
}
|
|
}
|
|
</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="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">
|
|
<A HREF="../../../org/simpleframework/xml/DefaultType.html" title="enum in org.simpleframework.xml"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../org/simpleframework/xml/ElementArray.html" title="annotation in org.simpleframework.xml"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../index.html?org/simpleframework/xml/Element.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Element.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: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</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.simpleframework.xml</FONT>
|
|
<BR>
|
|
Annotation Type Element</H2>
|
|
<HR>
|
|
<DL>
|
|
<DT><PRE><FONT SIZE="-1">@Retention(value=RUNTIME)
|
|
</FONT>public @interface <B>Element</B></DL>
|
|
</PRE>
|
|
|
|
<P>
|
|
The <code>Element</code> annotation is used to represent a field
|
|
or method that appears as an XML element. Fields or methods that
|
|
are annotated with this can be either primitive or compound, that
|
|
is, represent an object that can be serialized and deserialized.
|
|
Below is an example of the serialized format for a compound object.
|
|
<p>
|
|
If this annotates a type that contains no XML annotations then
|
|
this will look for a suitable <code>Transform</code> for the type
|
|
using the <code>Transformer</code>. For instance, all primitives
|
|
and primitive arrays that are annotated with this will make use
|
|
of a transform in order to convert its value to and from suitable
|
|
XML representations.
|
|
<pre>
|
|
|
|
<example class="demo.Example">
|
|
<data/>
|
|
<example>
|
|
|
|
</pre>
|
|
Each element may have any number of attributes and sub-elements
|
|
representing fields or methods of that compound object. Attribute
|
|
and element names can be acquired from the annotation or, if the
|
|
annotation does not explicitly declare a name, it is taken from
|
|
the annotated field or method. There are exceptions in some cases,
|
|
for example, the <code>class</code> attribute is reserved by the
|
|
serialization framework to represent the serialized type.
|
|
<P>
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>Author:</B></DT>
|
|
<DD>Niall Gallagher</DD>
|
|
</DL>
|
|
<HR>
|
|
|
|
<P>
|
|
<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
|
|
|
|
<A NAME="annotation_type_optional_element_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>Optional Element Summary</B></FONT></TH>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Element.html#data()">data</A></B></CODE>
|
|
|
|
<BR>
|
|
This is used to determine whether the element data is written
|
|
in a CDATA block or not.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.String</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Element.html#name()">name</A></B></CODE>
|
|
|
|
<BR>
|
|
This represents the name of the XML element.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> boolean</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Element.html#required()">required</A></B></CODE>
|
|
|
|
<BR>
|
|
Determines whether the element is required within the XML
|
|
document.</TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> java.lang.Class</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="../../../org/simpleframework/xml/Element.html#type()">type</A></B></CODE>
|
|
|
|
<BR>
|
|
This represents an explicit type that should be used for the
|
|
annotated field or method.</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<P>
|
|
<A NAME="name()"><!-- --></A><H3>
|
|
name</H3>
|
|
<PRE>
|
|
public abstract java.lang.String <B>name</B></PRE>
|
|
<DL>
|
|
<DD>This represents the name of the XML element. Annotated fields
|
|
can optionally provide the name of the element. If no name is
|
|
provided then the name of the annotated field or method will
|
|
be used in its place. The name is provided if the field or
|
|
method name is not suitable as an XML element name.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>the name of the XML element this represents</DL>
|
|
<DL>
|
|
<DT><B>Default:</B><DD>""</DD>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="data()"><!-- --></A><H3>
|
|
data</H3>
|
|
<PRE>
|
|
public abstract boolean <B>data</B></PRE>
|
|
<DL>
|
|
<DD>This is used to determine whether the element data is written
|
|
in a CDATA block or not. If this is set to true then the text
|
|
is written within a CDATA block, by default the text is output
|
|
as escaped XML. Typically this is useful for primitives only.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>true if the data is to be wrapped in a CDATA block</DL>
|
|
<DL>
|
|
<DT><B>Default:</B><DD>false</DD>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="required()"><!-- --></A><H3>
|
|
required</H3>
|
|
<PRE>
|
|
public abstract boolean <B>required</B></PRE>
|
|
<DL>
|
|
<DD>Determines whether the element is required within the XML
|
|
document. Any field marked as not required will not have its
|
|
value set when the object is deserialized. If an object is to
|
|
be serialized only a null attribute will not appear as XML.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>true if the element is required, false otherwise</DL>
|
|
<DL>
|
|
<DT><B>Default:</B><DD>true</DD>
|
|
</DL>
|
|
</DL>
|
|
<HR>
|
|
|
|
<A NAME="type()"><!-- --></A><H3>
|
|
type</H3>
|
|
<PRE>
|
|
public abstract java.lang.Class <B>type</B></PRE>
|
|
<DL>
|
|
<DD>This represents an explicit type that should be used for the
|
|
annotated field or method. Typically this is used when the
|
|
element forms part of a union group. It allows the union
|
|
to distinguish the annotation to use based on the type.
|
|
<P>
|
|
<DD><DL>
|
|
</DL>
|
|
</DD>
|
|
<DD><DL>
|
|
|
|
<DT><B>Returns:</B><DD>this returns the explicit type to use for this</DL>
|
|
<DL>
|
|
<DT><B>Default:</B><DD>void.class</DD>
|
|
</DL>
|
|
</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="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">
|
|
<A HREF="../../../org/simpleframework/xml/DefaultType.html" title="enum in org.simpleframework.xml"><B>PREV CLASS</B></A>
|
|
<A HREF="../../../org/simpleframework/xml/ElementArray.html" title="annotation in org.simpleframework.xml"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="../../../index.html?org/simpleframework/xml/Element.html" target="_top"><B>FRAMES</B></A>
|
|
<A HREF="Element.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: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<A NAME="skip-navbar_bottom"></A>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
|
|
<HR>
|
|
|
|
</BODY>
|
|
</HTML>
|