Skip to content

Commit 4d3b942

Browse files
committed
added docs
1 parent 9c90cf0 commit 4d3b942

File tree

90 files changed

+9673
-25
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

90 files changed

+9673
-25
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Protobuf-codec provides codec for protobuf and other data formats like xml/json. It is fast and relies on proven frameworks like [jackson](http://jackson.codehaus.org/)
33
for json and [woodstox]( http://woodstox.codehaus.org/) for xml for parsing.
44

5-
[[Project Wiki](https://github.com/sijuv/protobuf-codec/wiki)
5+
[Project Wiki](https://github.com/sijuv/protobuf-codec/wiki)
66

77
## UPDATES:
88
06/Dec :
@@ -23,8 +23,8 @@ Protobuf-codec provides codec for protobuf and other data formats like xml/json.
2323

2424

2525
## DEPENDENCIES :
26-
- Jackson for json parsing. [ see pom for details ]
27-
- woodstox for xml parsing [see pom for details ]
26+
- Jackson for json parsing.
27+
- woodstox for xml parsing
2828
- commons-codec for hex encode/decode
2929

3030

dist/apidocs/allclasses-frame.html

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!--NewPage-->
3+
<HTML>
4+
<HEAD>
5+
<!-- Generated by javadoc (build 1.6.0_21) on Wed Dec 08 18:10:24 IST 2010 -->
6+
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7+
<TITLE>
8+
All Classes (Protobuf codec parent pom 1.0 API)
9+
</TITLE>
10+
11+
<META NAME="date" CONTENT="2010-12-08">
12+
13+
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
14+
15+
16+
</HEAD>
17+
18+
<BODY BGCOLOR="white">
19+
<FONT size="+1" CLASS="FrameHeadingFont">
20+
<B>All Classes</B></FONT>
21+
<BR>
22+
23+
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
24+
<TR>
25+
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="protobuf/codec/AbstractCodec.html" title="class in protobuf.codec" target="classFrame">AbstractCodec</A>
26+
<BR>
27+
<A HREF="protobuf/codec/Codec.html" title="interface in protobuf.codec" target="classFrame"><I>Codec</I></A>
28+
<BR>
29+
<A HREF="protobuf/codec/Codec.Feature.html" title="enum in protobuf.codec" target="classFrame">Codec.Feature</A>
30+
<BR>
31+
<A HREF="protobuf/codec/json/JacksonJsonReader.html" title="class in protobuf.codec.json" target="classFrame">JacksonJsonReader</A>
32+
<BR>
33+
<A HREF="protobuf/codec/json/JacksonJsonWriter.html" title="class in protobuf.codec.json" target="classFrame">JacksonJsonWriter</A>
34+
<BR>
35+
<A HREF="protobuf/codec/json/JsonCodec.html" title="class in protobuf.codec.json" target="classFrame">JsonCodec</A>
36+
<BR>
37+
<A HREF="protobuf/codec/ParseException.html" title="class in protobuf.codec" target="classFrame">ParseException</A>
38+
<BR>
39+
<A HREF="protobuf/codec/xml/XmlCodec.html" title="class in protobuf.codec.xml" target="classFrame">XmlCodec</A>
40+
<BR>
41+
<A HREF="protobuf/codec/xml/XmlReader.html" title="class in protobuf.codec.xml" target="classFrame">XmlReader</A>
42+
<BR>
43+
<A HREF="protobuf/codec/xml/XmlWriter.html" title="class in protobuf.codec.xml" target="classFrame">XmlWriter</A>
44+
<BR>
45+
</FONT></TD>
46+
</TR>
47+
</TABLE>
48+
49+
</BODY>
50+
</HTML>

dist/apidocs/allclasses-noframe.html

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!--NewPage-->
3+
<HTML>
4+
<HEAD>
5+
<!-- Generated by javadoc (build 1.6.0_21) on Wed Dec 08 18:10:24 IST 2010 -->
6+
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7+
<TITLE>
8+
All Classes (Protobuf codec parent pom 1.0 API)
9+
</TITLE>
10+
11+
<META NAME="date" CONTENT="2010-12-08">
12+
13+
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
14+
15+
16+
</HEAD>
17+
18+
<BODY BGCOLOR="white">
19+
<FONT size="+1" CLASS="FrameHeadingFont">
20+
<B>All Classes</B></FONT>
21+
<BR>
22+
23+
<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
24+
<TR>
25+
<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="protobuf/codec/AbstractCodec.html" title="class in protobuf.codec">AbstractCodec</A>
26+
<BR>
27+
<A HREF="protobuf/codec/Codec.html" title="interface in protobuf.codec"><I>Codec</I></A>
28+
<BR>
29+
<A HREF="protobuf/codec/Codec.Feature.html" title="enum in protobuf.codec">Codec.Feature</A>
30+
<BR>
31+
<A HREF="protobuf/codec/json/JacksonJsonReader.html" title="class in protobuf.codec.json">JacksonJsonReader</A>
32+
<BR>
33+
<A HREF="protobuf/codec/json/JacksonJsonWriter.html" title="class in protobuf.codec.json">JacksonJsonWriter</A>
34+
<BR>
35+
<A HREF="protobuf/codec/json/JsonCodec.html" title="class in protobuf.codec.json">JsonCodec</A>
36+
<BR>
37+
<A HREF="protobuf/codec/ParseException.html" title="class in protobuf.codec">ParseException</A>
38+
<BR>
39+
<A HREF="protobuf/codec/xml/XmlCodec.html" title="class in protobuf.codec.xml">XmlCodec</A>
40+
<BR>
41+
<A HREF="protobuf/codec/xml/XmlReader.html" title="class in protobuf.codec.xml">XmlReader</A>
42+
<BR>
43+
<A HREF="protobuf/codec/xml/XmlWriter.html" title="class in protobuf.codec.xml">XmlWriter</A>
44+
<BR>
45+
</FONT></TD>
46+
</TR>
47+
</TABLE>
48+
49+
</BODY>
50+
</HTML>

dist/apidocs/constant-values.html

Lines changed: 199 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,199 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!--NewPage-->
3+
<HTML>
4+
<HEAD>
5+
<!-- Generated by javadoc (build 1.6.0_21) on Wed Dec 08 18:10:24 IST 2010 -->
6+
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
7+
<TITLE>
8+
Constant Field Values (Protobuf codec parent pom 1.0 API)
9+
</TITLE>
10+
11+
<META NAME="date" CONTENT="2010-12-08">
12+
13+
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
14+
15+
<SCRIPT type="text/javascript">
16+
function windowTitle()
17+
{
18+
if (location.href.indexOf('is-external=true') == -1) {
19+
parent.document.title="Constant Field Values (Protobuf codec parent pom 1.0 API)";
20+
}
21+
}
22+
</SCRIPT>
23+
<NOSCRIPT>
24+
</NOSCRIPT>
25+
26+
</HEAD>
27+
28+
<BODY BGCOLOR="white" onload="windowTitle();">
29+
<HR>
30+
31+
32+
<!-- ========= START OF TOP NAVBAR ======= -->
33+
<A NAME="navbar_top"><!-- --></A>
34+
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
35+
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
36+
<TR>
37+
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
38+
<A NAME="navbar_top_firstrow"><!-- --></A>
39+
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
40+
<TR ALIGN="center" VALIGN="top">
41+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
42+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
43+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
44+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
45+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
46+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
47+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
48+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
49+
</TR>
50+
</TABLE>
51+
</TD>
52+
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
53+
</EM>
54+
</TD>
55+
</TR>
56+
57+
<TR>
58+
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
59+
&nbsp;PREV&nbsp;
60+
&nbsp;NEXT</FONT></TD>
61+
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
62+
<A HREF="index.html?constant-values.html" target="_top"><B>FRAMES</B></A> &nbsp;
63+
&nbsp;<A HREF="constant-values.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
64+
&nbsp;<SCRIPT type="text/javascript">
65+
<!--
66+
if(window==top) {
67+
document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
68+
}
69+
//-->
70+
</SCRIPT>
71+
<NOSCRIPT>
72+
<A HREF="allclasses-noframe.html"><B>All Classes</B></A>
73+
</NOSCRIPT>
74+
75+
76+
</FONT></TD>
77+
</TR>
78+
</TABLE>
79+
<A NAME="skip-navbar_top"></A>
80+
<!-- ========= END OF TOP NAVBAR ========= -->
81+
82+
<HR>
83+
<CENTER>
84+
<H1>
85+
Constant Field Values</H1>
86+
</CENTER>
87+
<HR SIZE="4" NOSHADE>
88+
<B>Contents</B><UL>
89+
<LI><A HREF="#protobuf.codec">protobuf.codec.*</A>
90+
</UL>
91+
92+
<A NAME="protobuf.codec"><!-- --></A>
93+
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
94+
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
95+
<TH ALIGN="left"><FONT SIZE="+2">
96+
protobuf.codec.*</FONT></TH>
97+
</TR>
98+
</TABLE>
99+
100+
<P>
101+
102+
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
103+
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
104+
<TH ALIGN="left" COLSPAN="3">protobuf.codec.<A HREF="protobuf/codec/AbstractCodec.html" title="class in protobuf.codec">AbstractCodec</A></TH>
105+
</TR>
106+
<TR BGCOLOR="white" CLASS="TableRowColor">
107+
<A NAME="protobuf.codec.AbstractCodec.DEFAULT_CHARSET"><!-- --></A><TD ALIGN="right"><FONT SIZE="-1">
108+
<CODE>public&nbsp;static&nbsp;final&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
109+
<TD ALIGN="left"><CODE><A HREF="protobuf/codec/AbstractCodec.html#DEFAULT_CHARSET">DEFAULT_CHARSET</A></CODE></TD>
110+
<TD ALIGN="right"><CODE>"UTF-8"</CODE></TD>
111+
</TR>
112+
</FONT></TD>
113+
</TR>
114+
</TABLE>
115+
116+
<P>
117+
118+
<P>
119+
120+
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
121+
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
122+
<TH ALIGN="left" COLSPAN="3">protobuf.codec.<A HREF="protobuf/codec/Codec.html" title="interface in protobuf.codec">Codec</A></TH>
123+
</TR>
124+
<TR BGCOLOR="white" CLASS="TableRowColor">
125+
<A NAME="protobuf.codec.Codec.DEFAULT_EXTENSION_NAME_PREFIX"><!-- --></A><TD ALIGN="right"><FONT SIZE="-1">
126+
<CODE>public&nbsp;static&nbsp;final&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
127+
<TD ALIGN="left"><CODE><A HREF="protobuf/codec/Codec.html#DEFAULT_EXTENSION_NAME_PREFIX">DEFAULT_EXTENSION_NAME_PREFIX</A></CODE></TD>
128+
<TD ALIGN="right"><CODE>"extension"</CODE></TD>
129+
</TR>
130+
<TR BGCOLOR="white" CLASS="TableRowColor">
131+
<A NAME="protobuf.codec.Codec.DEFAULT_UNKNOWN_FIELD_ELEM_NAME"><!-- --></A><TD ALIGN="right"><FONT SIZE="-1">
132+
<CODE>public&nbsp;static&nbsp;final&nbsp;<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD>
133+
<TD ALIGN="left"><CODE><A HREF="protobuf/codec/Codec.html#DEFAULT_UNKNOWN_FIELD_ELEM_NAME">DEFAULT_UNKNOWN_FIELD_ELEM_NAME</A></CODE></TD>
134+
<TD ALIGN="right"><CODE>"unknownfields"</CODE></TD>
135+
</TR>
136+
</FONT></TD>
137+
</TR>
138+
</TABLE>
139+
140+
<P>
141+
142+
<P>
143+
<HR>
144+
145+
146+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
147+
<A NAME="navbar_bottom"><!-- --></A>
148+
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
149+
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
150+
<TR>
151+
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
152+
<A NAME="navbar_bottom_firstrow"><!-- --></A>
153+
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
154+
<TR ALIGN="center" VALIGN="top">
155+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
156+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Package</FONT>&nbsp;</TD>
157+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Class</FONT>&nbsp;</TD>
158+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <FONT CLASS="NavBarFont1">Use</FONT>&nbsp;</TD>
159+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
160+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
161+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
162+
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
163+
</TR>
164+
</TABLE>
165+
</TD>
166+
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
167+
</EM>
168+
</TD>
169+
</TR>
170+
171+
<TR>
172+
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
173+
&nbsp;PREV&nbsp;
174+
&nbsp;NEXT</FONT></TD>
175+
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
176+
<A HREF="index.html?constant-values.html" target="_top"><B>FRAMES</B></A> &nbsp;
177+
&nbsp;<A HREF="constant-values.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
178+
&nbsp;<SCRIPT type="text/javascript">
179+
<!--
180+
if(window==top) {
181+
document.writeln('<A HREF="allclasses-noframe.html"><B>All Classes</B></A>');
182+
}
183+
//-->
184+
</SCRIPT>
185+
<NOSCRIPT>
186+
<A HREF="allclasses-noframe.html"><B>All Classes</B></A>
187+
</NOSCRIPT>
188+
189+
190+
</FONT></TD>
191+
</TR>
192+
</TABLE>
193+
<A NAME="skip-navbar_bottom"></A>
194+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
195+
196+
<HR>
197+
Copyright &#169; 2010. All Rights Reserved.
198+
</BODY>
199+
</HTML>

0 commit comments

Comments
 (0)