com.example.retrofit.GitHubClient
+Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-jackson/deprecated-list.html b/website/1.x/converter-jackson/deprecated-list.html new file mode 100644 index 0000000000..28ebb22a36 --- /dev/null +++ b/website/1.x/converter-jackson/deprecated-list.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-jackson/help-doc.html b/website/1.x/converter-jackson/help-doc.html new file mode 100644 index 0000000000..2a4cf56366 --- /dev/null +++ b/website/1.x/converter-jackson/help-doc.html @@ -0,0 +1,225 @@ + + + + + + +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-jackson/index-all.html b/website/1.x/converter-jackson/index-all.html new file mode 100644 index 0000000000..d7411259c0 --- /dev/null +++ b/website/1.x/converter-jackson/index-all.html @@ -0,0 +1,159 @@ + + + + + + +Converter which uses Jackson for reading and writing entities.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-jackson/index.html b/website/1.x/converter-jackson/index.html new file mode 100644 index 0000000000..34b2984fb1 --- /dev/null +++ b/website/1.x/converter-jackson/index.html @@ -0,0 +1,72 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-jackson/package-list b/website/1.x/converter-jackson/package-list new file mode 100644 index 0000000000..725b908b9e --- /dev/null +++ b/website/1.x/converter-jackson/package-list @@ -0,0 +1 @@ +retrofit.converter diff --git a/website/1.x/converter-jackson/retrofit/converter/JacksonConverter.html b/website/1.x/converter-jackson/retrofit/converter/JacksonConverter.html new file mode 100644 index 0000000000..627cf1d4b5 --- /dev/null +++ b/website/1.x/converter-jackson/retrofit/converter/JacksonConverter.html @@ -0,0 +1,319 @@ + + + + + + +| Constructor and Description | +
|---|
JacksonConverter() |
+
JacksonConverter(com.fasterxml.jackson.databind.ObjectMapper objectMapper) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+fromBody(TypedInput body,
+ Type type) |
+
TypedOutput |
+toBody(Object object) |
+
public JacksonConverter()+
public JacksonConverter(com.fasterxml.jackson.databind.ObjectMapper objectMapper)+
public Object fromBody(TypedInput body, + Type type) + throws ConversionException+
fromBody in interface ConverterConversionExceptionpublic TypedOutput toBody(Object object)+ +
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-jackson/retrofit/converter/class-use/JacksonConverter.html b/website/1.x/converter-jackson/retrofit/converter/class-use/JacksonConverter.html new file mode 100644 index 0000000000..28f0d499fd --- /dev/null +++ b/website/1.x/converter-jackson/retrofit/converter/class-use/JacksonConverter.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-jackson/retrofit/converter/package-frame.html b/website/1.x/converter-jackson/retrofit/converter/package-frame.html new file mode 100644 index 0000000000..36f00ae612 --- /dev/null +++ b/website/1.x/converter-jackson/retrofit/converter/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| JacksonConverter | +
+ A
+Converter which uses Jackson for reading and writing entities. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-jackson/retrofit/converter/package-tree.html b/website/1.x/converter-jackson/retrofit/converter/package-tree.html new file mode 100644 index 0000000000..3461d9f786 --- /dev/null +++ b/website/1.x/converter-jackson/retrofit/converter/package-tree.html @@ -0,0 +1,133 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-jackson/retrofit/converter/package-use.html b/website/1.x/converter-jackson/retrofit/converter/package-use.html new file mode 100644 index 0000000000..d8d09da6ad --- /dev/null +++ b/website/1.x/converter-jackson/retrofit/converter/package-use.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-jackson/script.js b/website/1.x/converter-jackson/script.js new file mode 100644 index 0000000000..b346356931 --- /dev/null +++ b/website/1.x/converter-jackson/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/website/1.x/converter-jackson/stylesheet.css b/website/1.x/converter-jackson/stylesheet.css new file mode 100644 index 0000000000..cebb4fd8d5 --- /dev/null +++ b/website/1.x/converter-jackson/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; + width:100%; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/website/1.x/converter-jackson/version.txt b/website/1.x/converter-jackson/version.txt new file mode 100644 index 0000000000..abb1658232 --- /dev/null +++ b/website/1.x/converter-jackson/version.txt @@ -0,0 +1 @@ +1.9.0 \ No newline at end of file diff --git a/website/1.x/converter-protobuf/META-INF/MANIFEST.MF b/website/1.x/converter-protobuf/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..f61946eeb8 --- /dev/null +++ b/website/1.x/converter-protobuf/META-INF/MANIFEST.MF @@ -0,0 +1,6 @@ +Manifest-Version: 1.0 +Archiver-Version: Plexus Archiver +Created-By: Apache Maven +Built-By: jw +Build-Jdk: 1.8.0_25 + diff --git a/website/1.x/converter-protobuf/allclasses-frame.html b/website/1.x/converter-protobuf/allclasses-frame.html new file mode 100644 index 0000000000..44e52f801e --- /dev/null +++ b/website/1.x/converter-protobuf/allclasses-frame.html @@ -0,0 +1,20 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-protobuf/deprecated-list.html b/website/1.x/converter-protobuf/deprecated-list.html new file mode 100644 index 0000000000..96eec25301 --- /dev/null +++ b/website/1.x/converter-protobuf/deprecated-list.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-protobuf/help-doc.html b/website/1.x/converter-protobuf/help-doc.html new file mode 100644 index 0000000000..08b327b33b --- /dev/null +++ b/website/1.x/converter-protobuf/help-doc.html @@ -0,0 +1,225 @@ + + + + + + +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-protobuf/index-all.html b/website/1.x/converter-protobuf/index-all.html new file mode 100644 index 0000000000..e95f649e2b --- /dev/null +++ b/website/1.x/converter-protobuf/index-all.html @@ -0,0 +1,157 @@ + + + + + + +Converter that reads and writes protocol buffers.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-protobuf/index.html b/website/1.x/converter-protobuf/index.html new file mode 100644 index 0000000000..4e8fd3b420 --- /dev/null +++ b/website/1.x/converter-protobuf/index.html @@ -0,0 +1,72 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-protobuf/package-list b/website/1.x/converter-protobuf/package-list new file mode 100644 index 0000000000..725b908b9e --- /dev/null +++ b/website/1.x/converter-protobuf/package-list @@ -0,0 +1 @@ +retrofit.converter diff --git a/website/1.x/converter-protobuf/retrofit/converter/ProtoConverter.html b/website/1.x/converter-protobuf/retrofit/converter/ProtoConverter.html new file mode 100644 index 0000000000..c53b1d0f45 --- /dev/null +++ b/website/1.x/converter-protobuf/retrofit/converter/ProtoConverter.html @@ -0,0 +1,303 @@ + + + + + + +| Constructor and Description | +
|---|
ProtoConverter() |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+fromBody(TypedInput body,
+ Type type) |
+
TypedOutput |
+toBody(Object object) |
+
public Object fromBody(TypedInput body, + Type type) + throws ConversionException+
fromBody in interface ConverterConversionExceptionpublic TypedOutput toBody(Object object)+ +
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-protobuf/retrofit/converter/class-use/ProtoConverter.html b/website/1.x/converter-protobuf/retrofit/converter/class-use/ProtoConverter.html new file mode 100644 index 0000000000..b93053ca08 --- /dev/null +++ b/website/1.x/converter-protobuf/retrofit/converter/class-use/ProtoConverter.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-protobuf/retrofit/converter/package-frame.html b/website/1.x/converter-protobuf/retrofit/converter/package-frame.html new file mode 100644 index 0000000000..5cb7d49844 --- /dev/null +++ b/website/1.x/converter-protobuf/retrofit/converter/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| ProtoConverter | +
+ A
+Converter that reads and writes protocol buffers. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-protobuf/retrofit/converter/package-tree.html b/website/1.x/converter-protobuf/retrofit/converter/package-tree.html new file mode 100644 index 0000000000..35a16e7a5e --- /dev/null +++ b/website/1.x/converter-protobuf/retrofit/converter/package-tree.html @@ -0,0 +1,133 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-protobuf/retrofit/converter/package-use.html b/website/1.x/converter-protobuf/retrofit/converter/package-use.html new file mode 100644 index 0000000000..a7debb4f6d --- /dev/null +++ b/website/1.x/converter-protobuf/retrofit/converter/package-use.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-protobuf/script.js b/website/1.x/converter-protobuf/script.js new file mode 100644 index 0000000000..b346356931 --- /dev/null +++ b/website/1.x/converter-protobuf/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/website/1.x/converter-protobuf/stylesheet.css b/website/1.x/converter-protobuf/stylesheet.css new file mode 100644 index 0000000000..cebb4fd8d5 --- /dev/null +++ b/website/1.x/converter-protobuf/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; + width:100%; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/website/1.x/converter-protobuf/version.txt b/website/1.x/converter-protobuf/version.txt new file mode 100644 index 0000000000..abb1658232 --- /dev/null +++ b/website/1.x/converter-protobuf/version.txt @@ -0,0 +1 @@ +1.9.0 \ No newline at end of file diff --git a/website/1.x/converter-simplexml/META-INF/MANIFEST.MF b/website/1.x/converter-simplexml/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..f61946eeb8 --- /dev/null +++ b/website/1.x/converter-simplexml/META-INF/MANIFEST.MF @@ -0,0 +1,6 @@ +Manifest-Version: 1.0 +Archiver-Version: Plexus Archiver +Created-By: Apache Maven +Built-By: jw +Build-Jdk: 1.8.0_25 + diff --git a/website/1.x/converter-simplexml/allclasses-frame.html b/website/1.x/converter-simplexml/allclasses-frame.html new file mode 100644 index 0000000000..df37b5710f --- /dev/null +++ b/website/1.x/converter-simplexml/allclasses-frame.html @@ -0,0 +1,20 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-simplexml/deprecated-list.html b/website/1.x/converter-simplexml/deprecated-list.html new file mode 100644 index 0000000000..3aa0e55ec9 --- /dev/null +++ b/website/1.x/converter-simplexml/deprecated-list.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-simplexml/help-doc.html b/website/1.x/converter-simplexml/help-doc.html new file mode 100644 index 0000000000..3217eed00e --- /dev/null +++ b/website/1.x/converter-simplexml/help-doc.html @@ -0,0 +1,225 @@ + + + + + + +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-simplexml/index-all.html b/website/1.x/converter-simplexml/index-all.html new file mode 100644 index 0000000000..f4d7a453d1 --- /dev/null +++ b/website/1.x/converter-simplexml/index-all.html @@ -0,0 +1,171 @@ + + + + + + +Converter which uses SimpleXML for reading and writing entities.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-simplexml/index.html b/website/1.x/converter-simplexml/index.html new file mode 100644 index 0000000000..574f132a9e --- /dev/null +++ b/website/1.x/converter-simplexml/index.html @@ -0,0 +1,72 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-simplexml/package-list b/website/1.x/converter-simplexml/package-list new file mode 100644 index 0000000000..725b908b9e --- /dev/null +++ b/website/1.x/converter-simplexml/package-list @@ -0,0 +1 @@ +retrofit.converter diff --git a/website/1.x/converter-simplexml/retrofit/converter/SimpleXMLConverter.html b/website/1.x/converter-simplexml/retrofit/converter/SimpleXMLConverter.html new file mode 100644 index 0000000000..67ccae2a38 --- /dev/null +++ b/website/1.x/converter-simplexml/retrofit/converter/SimpleXMLConverter.html @@ -0,0 +1,358 @@ + + + + + + +| Constructor and Description | +
|---|
SimpleXMLConverter() |
+
SimpleXMLConverter(boolean strict) |
+
SimpleXMLConverter(org.simpleframework.xml.Serializer serializer) |
+
SimpleXMLConverter(org.simpleframework.xml.Serializer serializer,
+ boolean strict) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+fromBody(TypedInput body,
+ Type type) |
+
boolean |
+isStrict() |
+
TypedOutput |
+toBody(Object source) |
+
public SimpleXMLConverter()+
public SimpleXMLConverter(boolean strict)+
public SimpleXMLConverter(org.simpleframework.xml.Serializer serializer)+
public SimpleXMLConverter(org.simpleframework.xml.Serializer serializer, + boolean strict)+
public Object fromBody(TypedInput body, + Type type) + throws ConversionException+
fromBody in interface ConverterConversionExceptionpublic TypedOutput toBody(Object source)+ +
public boolean isStrict()+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-simplexml/retrofit/converter/class-use/SimpleXMLConverter.html b/website/1.x/converter-simplexml/retrofit/converter/class-use/SimpleXMLConverter.html new file mode 100644 index 0000000000..d8d6970ea5 --- /dev/null +++ b/website/1.x/converter-simplexml/retrofit/converter/class-use/SimpleXMLConverter.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-simplexml/retrofit/converter/package-frame.html b/website/1.x/converter-simplexml/retrofit/converter/package-frame.html new file mode 100644 index 0000000000..efc9966b95 --- /dev/null +++ b/website/1.x/converter-simplexml/retrofit/converter/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| SimpleXMLConverter | +
+ A
+Converter which uses SimpleXML for reading and writing entities. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-simplexml/retrofit/converter/package-tree.html b/website/1.x/converter-simplexml/retrofit/converter/package-tree.html new file mode 100644 index 0000000000..4db4fb5c5e --- /dev/null +++ b/website/1.x/converter-simplexml/retrofit/converter/package-tree.html @@ -0,0 +1,133 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-simplexml/retrofit/converter/package-use.html b/website/1.x/converter-simplexml/retrofit/converter/package-use.html new file mode 100644 index 0000000000..dd1368e0c9 --- /dev/null +++ b/website/1.x/converter-simplexml/retrofit/converter/package-use.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-simplexml/script.js b/website/1.x/converter-simplexml/script.js new file mode 100644 index 0000000000..b346356931 --- /dev/null +++ b/website/1.x/converter-simplexml/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/website/1.x/converter-simplexml/stylesheet.css b/website/1.x/converter-simplexml/stylesheet.css new file mode 100644 index 0000000000..cebb4fd8d5 --- /dev/null +++ b/website/1.x/converter-simplexml/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; + width:100%; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/website/1.x/converter-simplexml/version.txt b/website/1.x/converter-simplexml/version.txt new file mode 100644 index 0000000000..abb1658232 --- /dev/null +++ b/website/1.x/converter-simplexml/version.txt @@ -0,0 +1 @@ +1.9.0 \ No newline at end of file diff --git a/website/1.x/converter-wire/META-INF/MANIFEST.MF b/website/1.x/converter-wire/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..f61946eeb8 --- /dev/null +++ b/website/1.x/converter-wire/META-INF/MANIFEST.MF @@ -0,0 +1,6 @@ +Manifest-Version: 1.0 +Archiver-Version: Plexus Archiver +Created-By: Apache Maven +Built-By: jw +Build-Jdk: 1.8.0_25 + diff --git a/website/1.x/converter-wire/allclasses-frame.html b/website/1.x/converter-wire/allclasses-frame.html new file mode 100644 index 0000000000..abdacca7fc --- /dev/null +++ b/website/1.x/converter-wire/allclasses-frame.html @@ -0,0 +1,20 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-wire/deprecated-list.html b/website/1.x/converter-wire/deprecated-list.html new file mode 100644 index 0000000000..02dbb96783 --- /dev/null +++ b/website/1.x/converter-wire/deprecated-list.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-wire/help-doc.html b/website/1.x/converter-wire/help-doc.html new file mode 100644 index 0000000000..2645656fc7 --- /dev/null +++ b/website/1.x/converter-wire/help-doc.html @@ -0,0 +1,225 @@ + + + + + + +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-wire/index-all.html b/website/1.x/converter-wire/index-all.html new file mode 100644 index 0000000000..200e69a197 --- /dev/null +++ b/website/1.x/converter-wire/index-all.html @@ -0,0 +1,163 @@ + + + + + + +Converter that reads and writes protocol buffers using Wire.Wire instance.Wire instance.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-wire/index.html b/website/1.x/converter-wire/index.html new file mode 100644 index 0000000000..06420e81d0 --- /dev/null +++ b/website/1.x/converter-wire/index.html @@ -0,0 +1,72 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-wire/package-list b/website/1.x/converter-wire/package-list new file mode 100644 index 0000000000..725b908b9e --- /dev/null +++ b/website/1.x/converter-wire/package-list @@ -0,0 +1 @@ +retrofit.converter diff --git a/website/1.x/converter-wire/retrofit/converter/WireConverter.html b/website/1.x/converter-wire/retrofit/converter/WireConverter.html new file mode 100644 index 0000000000..fc1bb68e2e --- /dev/null +++ b/website/1.x/converter-wire/retrofit/converter/WireConverter.html @@ -0,0 +1,321 @@ + + + + + + +| Constructor and Description | +
|---|
WireConverter()
+Create a converter with a default
+Wire instance. |
+
WireConverter(com.squareup.wire.Wire wire)
+Create a converter using the supplied
+Wire instance. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+fromBody(TypedInput body,
+ Type type) |
+
TypedOutput |
+toBody(Object object) |
+
public WireConverter()+
Wire instance.public WireConverter(com.squareup.wire.Wire wire)+
Wire instance.public Object fromBody(TypedInput body, + Type type) + throws ConversionException+
fromBody in interface ConverterConversionExceptionpublic TypedOutput toBody(Object object)+ +
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-wire/retrofit/converter/class-use/WireConverter.html b/website/1.x/converter-wire/retrofit/converter/class-use/WireConverter.html new file mode 100644 index 0000000000..12531dd7ba --- /dev/null +++ b/website/1.x/converter-wire/retrofit/converter/class-use/WireConverter.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-wire/retrofit/converter/package-frame.html b/website/1.x/converter-wire/retrofit/converter/package-frame.html new file mode 100644 index 0000000000..e035dc51e5 --- /dev/null +++ b/website/1.x/converter-wire/retrofit/converter/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| WireConverter | +
+ A
+Converter that reads and writes protocol buffers using Wire. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-wire/retrofit/converter/package-tree.html b/website/1.x/converter-wire/retrofit/converter/package-tree.html new file mode 100644 index 0000000000..136a7259d9 --- /dev/null +++ b/website/1.x/converter-wire/retrofit/converter/package-tree.html @@ -0,0 +1,133 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-wire/retrofit/converter/package-use.html b/website/1.x/converter-wire/retrofit/converter/package-use.html new file mode 100644 index 0000000000..481caf4dec --- /dev/null +++ b/website/1.x/converter-wire/retrofit/converter/package-use.html @@ -0,0 +1,124 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/converter-wire/script.js b/website/1.x/converter-wire/script.js new file mode 100644 index 0000000000..b346356931 --- /dev/null +++ b/website/1.x/converter-wire/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/website/1.x/converter-wire/stylesheet.css b/website/1.x/converter-wire/stylesheet.css new file mode 100644 index 0000000000..cebb4fd8d5 --- /dev/null +++ b/website/1.x/converter-wire/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; + width:100%; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/website/1.x/converter-wire/version.txt b/website/1.x/converter-wire/version.txt new file mode 100644 index 0000000000..abb1658232 --- /dev/null +++ b/website/1.x/converter-wire/version.txt @@ -0,0 +1 @@ +1.9.0 \ No newline at end of file diff --git a/website/1.x/retrofit-mock/META-INF/MANIFEST.MF b/website/1.x/retrofit-mock/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..f61946eeb8 --- /dev/null +++ b/website/1.x/retrofit-mock/META-INF/MANIFEST.MF @@ -0,0 +1,6 @@ +Manifest-Version: 1.0 +Archiver-Version: Plexus Archiver +Created-By: Apache Maven +Built-By: jw +Build-Jdk: 1.8.0_25 + diff --git a/website/1.x/retrofit-mock/allclasses-frame.html b/website/1.x/retrofit-mock/allclasses-frame.html new file mode 100644 index 0000000000..21476922a5 --- /dev/null +++ b/website/1.x/retrofit-mock/allclasses-frame.html @@ -0,0 +1,23 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/deprecated-list.html b/website/1.x/retrofit-mock/deprecated-list.html new file mode 100644 index 0000000000..99fe7b599d --- /dev/null +++ b/website/1.x/retrofit-mock/deprecated-list.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/help-doc.html b/website/1.x/retrofit-mock/help-doc.html new file mode 100644 index 0000000000..5786b19084 --- /dev/null +++ b/website/1.x/retrofit-mock/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/index-all.html b/website/1.x/retrofit-mock/index-all.html new file mode 100644 index 0000000000..37e5335c3b --- /dev/null +++ b/website/1.x/retrofit-mock/index-all.html @@ -0,0 +1,314 @@ + + + + + + +value change listener for MockRestAdapter
+ which stores any customized behavior values into shared preferences.MockRestAdapter which will act as a factory for mock services.MockRestAdapter.calculateIsFailure() that return true.value change listener on the supplied
+ MockRestAdapter using the SharedPreferences for storing customized behavior
+ values.MockRestAdapter change.MockHttpException for HTTP 400 Bad Request.MockHttpException for HTTP 403 Forbidden.MockHttpException for HTTP 500 Internal Server Error.MockHttpException for HTTP 301 Moved Permanently.MockHttpException for HTTP 302 Moved Temporarily.MockHttpException for HTTP 404 Not Found.MockHttpException for HTTP 401 Unauthorized.MockRestAdapter.calculateIsFailure() that return true.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/index.html b/website/1.x/retrofit-mock/index.html new file mode 100644 index 0000000000..05377688b5 --- /dev/null +++ b/website/1.x/retrofit-mock/index.html @@ -0,0 +1,75 @@ + + + + + + ++ + diff --git a/website/1.x/retrofit-mock/overview-summary.html b/website/1.x/retrofit-mock/overview-summary.html new file mode 100644 index 0000000000..824d94fc7b --- /dev/null +++ b/website/1.x/retrofit-mock/overview-summary.html @@ -0,0 +1,144 @@ + + + + + + +
| Package | +Description | +
|---|---|
| retrofit | ++ |
| retrofit.android | ++ |
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/overview-tree.html b/website/1.x/retrofit-mock/overview-tree.html new file mode 100644 index 0000000000..8ccda2b175 --- /dev/null +++ b/website/1.x/retrofit-mock/overview-tree.html @@ -0,0 +1,158 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/package-list b/website/1.x/retrofit-mock/package-list new file mode 100644 index 0000000000..18e9d3a2cb --- /dev/null +++ b/website/1.x/retrofit-mock/package-list @@ -0,0 +1,2 @@ +retrofit +retrofit.android diff --git a/website/1.x/retrofit-mock/retrofit/MockHttpException.html b/website/1.x/retrofit-mock/retrofit/MockHttpException.html new file mode 100644 index 0000000000..ddc6c9787f --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/MockHttpException.html @@ -0,0 +1,439 @@ + + + + + + +public class MockHttpException +extends RuntimeException+
MockRestAdapter,
+Serialized Form| Constructor and Description | +
|---|
MockHttpException(int code,
+ String reason,
+ Object responseBody)
+Create a new HTTP exception.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static MockHttpException |
+newBadRequest(Object responseBody)
+Create a new
+MockHttpException for HTTP 400 Bad Request. |
+
static MockHttpException |
+newForbidden(Object responseBody)
+Create a new
+MockHttpException for HTTP 403 Forbidden. |
+
static MockHttpException |
+newInternalError(Object responseBody)
+Create a new
+MockHttpException for HTTP 500 Internal Server Error. |
+
static MockHttpException |
+newMovedPermanentely(String location,
+ Object responseBody)
+Create a new
+MockHttpException for HTTP 301 Moved Permanently. |
+
static MockHttpException |
+newMovedTemporarily(String location,
+ Object responseBody)
+Create a new
+MockHttpException for HTTP 302 Moved Temporarily. |
+
static MockHttpException |
+newNotFound(Object responseBody)
+Create a new
+MockHttpException for HTTP 404 Not Found. |
+
static MockHttpException |
+newUnauthorized(Object responseBody)
+Create a new
+MockHttpException for HTTP 401 Unauthorized. |
+
MockHttpException |
+withHeader(String name,
+ String value)
+Add a header to the response.
+ |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic MockHttpException(int code, + String reason, + Object responseBody)+
code - HTTP status code to trigger. Must be 300 or higher.reason - HTTP status reason message.responseBody - Object to use as the contents of the response body.public static MockHttpException newMovedPermanentely(String location, + Object responseBody)+
MockHttpException for HTTP 301 Moved Permanently.public static MockHttpException newMovedTemporarily(String location, + Object responseBody)+
MockHttpException for HTTP 302 Moved Temporarily.public static MockHttpException newBadRequest(Object responseBody)+
MockHttpException for HTTP 400 Bad Request.public static MockHttpException newUnauthorized(Object responseBody)+
MockHttpException for HTTP 401 Unauthorized.public static MockHttpException newForbidden(Object responseBody)+
MockHttpException for HTTP 403 Forbidden.public static MockHttpException newNotFound(Object responseBody)+
MockHttpException for HTTP 404 Not Found.public static MockHttpException newInternalError(Object responseBody)+
MockHttpException for HTTP 500 Internal Server Error.public MockHttpException withHeader(String name, + String value)+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/MockRestAdapter.ValueChangeListener.html b/website/1.x/retrofit-mock/retrofit/MockRestAdapter.ValueChangeListener.html new file mode 100644 index 0000000000..199f37b093 --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/MockRestAdapter.ValueChangeListener.html @@ -0,0 +1,272 @@ + + + + + + +public static interface MockRestAdapter.ValueChangeListener
+MockRestAdapter change.| Modifier and Type | +Field and Description | +
|---|---|
static MockRestAdapter.ValueChangeListener |
+EMPTY |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+onMockValuesChanged(long delayMs,
+ int variancePct,
+ int errorPct) |
+
static final MockRestAdapter.ValueChangeListener EMPTY+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/MockRestAdapter.html b/website/1.x/retrofit-mock/retrofit/MockRestAdapter.html new file mode 100644 index 0000000000..6be4ee5b2b --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/MockRestAdapter.html @@ -0,0 +1,506 @@ + + + + + + +public final class MockRestAdapter +extends Object+
+ Because APIs are defined as interfaces, versions of the API that use mock data can be created by + simply implementing the API interface on a class. These mock implementations execute + synchronously which is a large deviation from the behavior of those backed by an API call over + the network. By wrapping the mock instances using this class, the interface will still use mock + data but exhibit the delays and errors that a real network would face. +
+ Create an API interface and a mock implementation of it. +
+ public interface UserService {
+ @GET("/user/{id}")
+ User getUser(@Path("id") String userId);
+ }
+ public class MockUserService implements UserService {
+ @Override public User getUser(String userId) {
+ return new User("Jake");
+ }
+ }
+
+ Given a RestAdapter an instance of this class can be created by calling from(retrofit.RestAdapter).
+ + MockRestAdapter mockRestAdapter = MockRestAdapter.from(restAdapter); ++ Instances of this class should be used as a singleton so that the behavior of every mock service + is consistent. +
+ Rather than using the MockUserService directly, pass it through
+ the create method.
+
+ UserService service = mockRestAdapter.create(UserService.class, new MockUserService()); ++ The returned
UserService instance will now behave like it is happening over the network
+ while allowing the mock implementation to be written synchronously.
+
+ HTTP errors can be simulated in your mock services by throwing an instance of
+ MockHttpException. This should be done for both synchronous and asynchronous methods.
+ Do not call the failure() method of a callback.
| Modifier and Type | +Class and Description | +
|---|---|
static interface |
+MockRestAdapter.ValueChangeListener
+A listener invoked when the network behavior values for a
+MockRestAdapter change. |
+
| Modifier and Type | +Method and Description | +
|---|---|
int |
+calculateDelayForCall()
+Get the delay (in milliseconds) that should be used for delaying a network call response.
+ |
+
int |
+calculateDelayForError()
+Get the delay (in milliseconds) that should be used for triggering a network error.
+ |
+
boolean |
+calculateIsFailure()
+Randomly determine whether this call should result in a network failure.
+ |
+
<T> T |
+create(Class<T> service,
+ T mockService)
+Wrap the supplied mock implementation of a service so that it exhibits the delay and error
+ characteristics of a real network.
+ |
+
static MockRestAdapter |
+from(RestAdapter restAdapter)
+Create a new
+MockRestAdapter which will act as a factory for mock services. |
+
long |
+getDelay()
+The network round trip delay, in milliseconds
+ |
+
int |
+getErrorPercentage()
+The percentage of calls to
+calculateIsFailure() that return true. |
+
int |
+getVariancePercentage()
+The plus-or-minus variance percentage of the network round trip delay.
+ |
+
void |
+setDelay(long delayMs)
+Set the network round trip delay, in milliseconds.
+ |
+
void |
+setErrorPercentage(int errorPct)
+Set the percentage of calls to
+calculateIsFailure() that return true. |
+
void |
+setValueChangeListener(MockRestAdapter.ValueChangeListener listener)
+Set a listener to be notified when any mock value changes.
+ |
+
void |
+setVariancePercentage(int variancePct)
+Set the plus-or-minus variance percentage of the network round trip delay.
+ |
+
public static MockRestAdapter from(RestAdapter restAdapter)+
MockRestAdapter which will act as a factory for mock services. Some of
+ the configuration of the supplied RestAdapter will be used generating mock behavior.public void setValueChangeListener(MockRestAdapter.ValueChangeListener listener)+
public void setDelay(long delayMs)+
public long getDelay()+
public void setVariancePercentage(int variancePct)+
public int getVariancePercentage()+
public void setErrorPercentage(int errorPct)+
calculateIsFailure() that return true.public int getErrorPercentage()+
calculateIsFailure() that return true.public boolean calculateIsFailure()+
+ This method is exposed for implementing other, non-Retrofit services which exhibit similar
+ network behavior. Retrofit services automatically will exhibit network behavior when wrapped
+ using create(Class, Object).
public int calculateDelayForError()+
+ Because we are triggering an error, use a random delay between 0 and three times the normal + network delay to simulate a flaky connection failing anywhere from quickly to slowly. +
+ This method is exposed for implementing other, non-Retrofit services which exhibit similar
+ network behavior. Retrofit services automatically will exhibit network behavior when wrapped
+ using create(Class, Object).
public int calculateDelayForCall()+
+ This method is exposed for implementing other, non-Retrofit services which exhibit similar
+ network behavior. Retrofit services automatically will exhibit network behavior when wrapped
+ using create(Class, Object).
public <T> T create(Class<T> service, + T mockService)+
setDelay(long),
+setVariancePercentage(int),
+setErrorPercentage(int)Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/android/AndroidMockValuePersistence.html b/website/1.x/retrofit-mock/retrofit/android/AndroidMockValuePersistence.html new file mode 100644 index 0000000000..d122865bdc --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/android/AndroidMockValuePersistence.html @@ -0,0 +1,291 @@ + + + + + + +public final class AndroidMockValuePersistence +extends Object +implements MockRestAdapter.ValueChangeListener+
value change listener for MockRestAdapter
+ which stores any customized behavior values into shared preferences.EMPTY| Modifier and Type | +Method and Description | +
|---|---|
static void |
+install(MockRestAdapter mockRestAdapter,
+ android.content.SharedPreferences preferences)
+Install a
+value change listener on the supplied
+ MockRestAdapter using the SharedPreferences for storing customized behavior
+ values. |
+
void |
+onMockValuesChanged(long delayMs,
+ int variancePct,
+ int errorPct) |
+
public static void install(MockRestAdapter mockRestAdapter, + android.content.SharedPreferences preferences)+
value change listener on the supplied
+ MockRestAdapter using the SharedPreferences for storing customized behavior
+ values. Invoking this will load any existing stored values for the mock adapter's behavior.public void onMockValuesChanged(long delayMs, + int variancePct, + int errorPct)+
onMockValuesChanged in interface MockRestAdapter.ValueChangeListenerCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/android/class-use/AndroidMockValuePersistence.html b/website/1.x/retrofit-mock/retrofit/android/class-use/AndroidMockValuePersistence.html new file mode 100644 index 0000000000..b072feee1a --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/android/class-use/AndroidMockValuePersistence.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/android/package-frame.html b/website/1.x/retrofit-mock/retrofit/android/package-frame.html new file mode 100644 index 0000000000..ea6a05a9a8 --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/android/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| AndroidMockValuePersistence | +
+ A
+value change listener for MockRestAdapter
+ which stores any customized behavior values into shared preferences. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/android/package-tree.html b/website/1.x/retrofit-mock/retrofit/android/package-tree.html new file mode 100644 index 0000000000..d236548435 --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/android/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/android/package-use.html b/website/1.x/retrofit-mock/retrofit/android/package-use.html new file mode 100644 index 0000000000..8c9ce965c6 --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/android/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/class-use/MockHttpException.html b/website/1.x/retrofit-mock/retrofit/class-use/MockHttpException.html new file mode 100644 index 0000000000..52e709efb2 --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/class-use/MockHttpException.html @@ -0,0 +1,213 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static MockHttpException |
+MockHttpException.newBadRequest(Object responseBody)
+Create a new
+MockHttpException for HTTP 400 Bad Request. |
+
static MockHttpException |
+MockHttpException.newForbidden(Object responseBody)
+Create a new
+MockHttpException for HTTP 403 Forbidden. |
+
static MockHttpException |
+MockHttpException.newInternalError(Object responseBody)
+Create a new
+MockHttpException for HTTP 500 Internal Server Error. |
+
static MockHttpException |
+MockHttpException.newMovedPermanentely(String location,
+ Object responseBody)
+Create a new
+MockHttpException for HTTP 301 Moved Permanently. |
+
static MockHttpException |
+MockHttpException.newMovedTemporarily(String location,
+ Object responseBody)
+Create a new
+MockHttpException for HTTP 302 Moved Temporarily. |
+
static MockHttpException |
+MockHttpException.newNotFound(Object responseBody)
+Create a new
+MockHttpException for HTTP 404 Not Found. |
+
static MockHttpException |
+MockHttpException.newUnauthorized(Object responseBody)
+Create a new
+MockHttpException for HTTP 401 Unauthorized. |
+
MockHttpException |
+MockHttpException.withHeader(String name,
+ String value)
+Add a header to the response.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/class-use/MockRestAdapter.ValueChangeListener.html b/website/1.x/retrofit-mock/retrofit/class-use/MockRestAdapter.ValueChangeListener.html new file mode 100644 index 0000000000..c063f5ea47 --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/class-use/MockRestAdapter.ValueChangeListener.html @@ -0,0 +1,206 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | ++ |
| retrofit.android | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
static MockRestAdapter.ValueChangeListener |
+MockRestAdapter.ValueChangeListener.EMPTY |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+MockRestAdapter.setValueChangeListener(MockRestAdapter.ValueChangeListener listener)
+Set a listener to be notified when any mock value changes.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AndroidMockValuePersistence
+A
+value change listener for MockRestAdapter
+ which stores any customized behavior values into shared preferences. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/class-use/MockRestAdapter.html b/website/1.x/retrofit-mock/retrofit/class-use/MockRestAdapter.html new file mode 100644 index 0000000000..da80bf3b7e --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/class-use/MockRestAdapter.html @@ -0,0 +1,195 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | ++ |
| retrofit.android | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static MockRestAdapter |
+MockRestAdapter.from(RestAdapter restAdapter)
+Create a new
+MockRestAdapter which will act as a factory for mock services. |
+
| Modifier and Type | +Method and Description | +
|---|---|
static void |
+AndroidMockValuePersistence.install(MockRestAdapter mockRestAdapter,
+ android.content.SharedPreferences preferences)
+Install a
+value change listener on the supplied
+ MockRestAdapter using the SharedPreferences for storing customized behavior
+ values. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/package-frame.html b/website/1.x/retrofit-mock/retrofit/package-frame.html new file mode 100644 index 0000000000..b398f0cdfb --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/package-frame.html @@ -0,0 +1,29 @@ + + + + + + +| Interface | +Description | +
|---|---|
| MockRestAdapter.ValueChangeListener | +
+ A listener invoked when the network behavior values for a
+MockRestAdapter change. |
+
| Class | +Description | +
|---|---|
| MockRestAdapter | +
+ Wraps mock implementations of API interfaces so that they exhibit the delay and error
+ characteristics of a real network.
+ |
+
| Exception | +Description | +
|---|---|
| MockHttpException | +
+ An exception used to trigger the simulation of an HTTP error for mock services.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/package-tree.html b/website/1.x/retrofit-mock/retrofit/package-tree.html new file mode 100644 index 0000000000..3364f620fe --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/package-tree.html @@ -0,0 +1,156 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/retrofit/package-use.html b/website/1.x/retrofit-mock/retrofit/package-use.html new file mode 100644 index 0000000000..b752d9fc48 --- /dev/null +++ b/website/1.x/retrofit-mock/retrofit/package-use.html @@ -0,0 +1,199 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | ++ |
| retrofit.android | ++ |
| Class and Description | +
|---|
| MockHttpException
+ An exception used to trigger the simulation of an HTTP error for mock services.
+ |
+
| MockRestAdapter
+ Wraps mock implementations of API interfaces so that they exhibit the delay and error
+ characteristics of a real network.
+ |
+
| MockRestAdapter.ValueChangeListener
+ A listener invoked when the network behavior values for a
+MockRestAdapter change. |
+
| Class and Description | +
|---|
| MockRestAdapter
+ Wraps mock implementations of API interfaces so that they exhibit the delay and error
+ characteristics of a real network.
+ |
+
| MockRestAdapter.ValueChangeListener
+ A listener invoked when the network behavior values for a
+MockRestAdapter change. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/script.js b/website/1.x/retrofit-mock/script.js new file mode 100644 index 0000000000..b346356931 --- /dev/null +++ b/website/1.x/retrofit-mock/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/website/1.x/retrofit-mock/serialized-form.html b/website/1.x/retrofit-mock/serialized-form.html new file mode 100644 index 0000000000..205fbde385 --- /dev/null +++ b/website/1.x/retrofit-mock/serialized-form.html @@ -0,0 +1,194 @@ + + + + + + +String url+
Response response+
Converter converter+
Type successType+
RetrofitError.Kind kind+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit-mock/stylesheet.css b/website/1.x/retrofit-mock/stylesheet.css new file mode 100644 index 0000000000..cebb4fd8d5 --- /dev/null +++ b/website/1.x/retrofit-mock/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; + width:100%; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/website/1.x/retrofit-mock/version.txt b/website/1.x/retrofit-mock/version.txt new file mode 100644 index 0000000000..abb1658232 --- /dev/null +++ b/website/1.x/retrofit-mock/version.txt @@ -0,0 +1 @@ +1.9.0 \ No newline at end of file diff --git a/website/1.x/retrofit/META-INF/MANIFEST.MF b/website/1.x/retrofit/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..f61946eeb8 --- /dev/null +++ b/website/1.x/retrofit/META-INF/MANIFEST.MF @@ -0,0 +1,6 @@ +Manifest-Version: 1.0 +Archiver-Version: Plexus Archiver +Created-By: Apache Maven +Built-By: jw +Build-Jdk: 1.8.0_25 + diff --git a/website/1.x/retrofit/allclasses-frame.html b/website/1.x/retrofit/allclasses-frame.html new file mode 100644 index 0000000000..79f9ae38fc --- /dev/null +++ b/website/1.x/retrofit/allclasses-frame.html @@ -0,0 +1,80 @@ + + + + + + +| Modifier and Type | +Constant Field | +Value | +
|---|---|---|
+
+public static final String |
+DEFAULT_TRANSFER_ENCODING |
+"binary" |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/deprecated-list.html b/website/1.x/retrofit/deprecated-list.html new file mode 100644 index 0000000000..bd04aa504b --- /dev/null +++ b/website/1.x/retrofit/deprecated-list.html @@ -0,0 +1,186 @@ + + + + + + +| Annotation Type and Description | +
|---|
| retrofit.http.EncodedPath
+ Use
+Path with encode = false. |
+
| retrofit.http.EncodedQuery
+ Use
+Query with encodeValue = false. |
+
| retrofit.http.EncodedQueryMap
+ Use
+QueryMap with encodeValues = false. |
+
| Method and Description | +
|---|
| retrofit.RetrofitError.isNetworkError() + + | +
| retrofit.mime.MimeUtil.parseCharset(String) + + | +
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/help-doc.html b/website/1.x/retrofit/help-doc.html new file mode 100644 index 0000000000..ab27855ab7 --- /dev/null +++ b/website/1.x/retrofit/help-doc.html @@ -0,0 +1,231 @@ + + + + + + +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.
+Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:
+Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
+Each annotation type has its own separate page with the following sections:
+Each enum has its own separate page with the following sections:
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
+These links take you to the next or previous class, interface, package, or related page.
+These links show and hide the HTML frames. All pages are available with or without frames.
+The All Classes link shows all classes and interfaces except non-static nested types.
+Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.
+The Constant Field Values page lists the static final fields and their values.
+Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/index-all.html b/website/1.x/retrofit/index-all.html new file mode 100644 index 0000000000..fceccb5010 --- /dev/null +++ b/website/1.x/retrofit/index-all.html @@ -0,0 +1,999 @@ + + + + + + +logger for Android.Client which uses an implementation of Apache's HttpClient.DefaultHttpClient.RestAdapter instances.Requests.Client.service interface.ErrorHandler which returns the original error.Path with encode = false.Query with encodeValue = false.QueryMap with encodeValues = false.Endpoint instances.response exceptions.request using the provided urlFetchService.request using the provided client.request and encapsulate all response data
+ into a Response instance.null.Callback parameter.type.null.Callback parameter.Converter which uses GSON for serialization and deserialization of entities.Gson object for conversion.Gson object for conversion.RetrofitError.value.AndroidLog.log(String).RequestInterceptor which does no modification of requests.RestAdapter.Log implementation which does not log anything.Content-Type header value.Callback which returns only Response object
+ in Callback.success(Object, retrofit.client.Response) method.RestAdapter.RetrofitError.Response as is,
+ i.e.HttpURLConnection for communication.Client for Google AppEngine's which uses its URLFetchService.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/index.html b/website/1.x/retrofit/index.html new file mode 100644 index 0000000000..fa539c0d84 --- /dev/null +++ b/website/1.x/retrofit/index.html @@ -0,0 +1,75 @@ + + + + + + ++ + diff --git a/website/1.x/retrofit/overview-summary.html b/website/1.x/retrofit/overview-summary.html new file mode 100644 index 0000000000..d9cf5771cb --- /dev/null +++ b/website/1.x/retrofit/overview-summary.html @@ -0,0 +1,168 @@ + + + + + + +
| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| retrofit.android | ++ |
| retrofit.appengine | ++ |
| retrofit.client | ++ |
| retrofit.converter | ++ |
| retrofit.http | +
+ Annotations for interface methods to control the HTTP request behavior.
+ |
+
| retrofit.mime | ++ |
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/overview-tree.html b/website/1.x/retrofit/overview-tree.html new file mode 100644 index 0000000000..ad4b32eeeb --- /dev/null +++ b/website/1.x/retrofit/overview-tree.html @@ -0,0 +1,240 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/package-list b/website/1.x/retrofit/package-list new file mode 100644 index 0000000000..269bc98585 --- /dev/null +++ b/website/1.x/retrofit/package-list @@ -0,0 +1,7 @@ +retrofit +retrofit.android +retrofit.appengine +retrofit.client +retrofit.converter +retrofit.http +retrofit.mime diff --git a/website/1.x/retrofit/retrofit/Callback.html b/website/1.x/retrofit/retrofit/Callback.html new file mode 100644 index 0000000000..e6df9767aa --- /dev/null +++ b/website/1.x/retrofit/retrofit/Callback.html @@ -0,0 +1,269 @@ + + + + + + +T - expected response typepublic interface Callback<T>
+
+ Callback methods are executed using the RestAdapter callback executor. When none is
+ specified, the following defaults are used:
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+failure(RetrofitError error)
+Unsuccessful HTTP response due to network failure, non-2XX status code, or unexpected
+ exception.
+ |
+
void |
+success(T t,
+ Response response)
+Successful HTTP response.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/Endpoint.html b/website/1.x/retrofit/retrofit/Endpoint.html new file mode 100644 index 0000000000..7c531fbe0c --- /dev/null +++ b/website/1.x/retrofit/retrofit/Endpoint.html @@ -0,0 +1,248 @@ + + + + + + +public interface Endpoint
+| Modifier and Type | +Method and Description | +
|---|---|
String |
+getName()
+A name for differentiating between multiple API URLs.
+ |
+
String |
+getUrl()
+The base API URL.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/Endpoints.html b/website/1.x/retrofit/retrofit/Endpoints.html new file mode 100644 index 0000000000..c5bece8a19 --- /dev/null +++ b/website/1.x/retrofit/retrofit/Endpoints.html @@ -0,0 +1,265 @@ + + + + + + +| Modifier and Type | +Method and Description | +
|---|---|
static Endpoint |
+newFixedEndpoint(String url)
+Create a server with the provided URL.
+ |
+
static Endpoint |
+newFixedEndpoint(String url,
+ String name)
+Create an endpoint with the provided URL and name.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/ErrorHandler.html b/website/1.x/retrofit/retrofit/ErrorHandler.html new file mode 100644 index 0000000000..0243bf9550 --- /dev/null +++ b/website/1.x/retrofit/retrofit/ErrorHandler.html @@ -0,0 +1,293 @@ + + + + + + +public interface ErrorHandler
+response exceptions.| Modifier and Type | +Field and Description | +
|---|---|
static ErrorHandler |
+DEFAULT
+An
+ErrorHandler which returns the original error. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Throwable |
+handleError(RetrofitError cause)
+Return a custom exception to be thrown for a
+RetrofitError. |
+
static final ErrorHandler DEFAULT+
ErrorHandler which returns the original error.Throwable handleError(RetrofitError cause)+
RetrofitError. It is recommended that you
+ pass the supplied error as the cause to any new exceptions.
+ + If the return exception is checked it must be declared to be thrown on the interface method. +
+ Example usage: +
+ class MyErrorHandler implements ErrorHandler {
+ @Override public Throwable handleError(RetrofitError cause) {
+ Response r = cause.getResponse();
+ if (r != null && r.getStatus() == 401) {
+ return new UnauthorizedException(cause);
+ }
+ return cause;
+ }
+ }
+ cause - the original RetrofitError exceptionnull.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/Profiler.RequestInformation.html b/website/1.x/retrofit/retrofit/Profiler.RequestInformation.html new file mode 100644 index 0000000000..f7fea6fd8f --- /dev/null +++ b/website/1.x/retrofit/retrofit/Profiler.RequestInformation.html @@ -0,0 +1,353 @@ + + + + + + +| Constructor and Description | +
|---|
RequestInformation(String method,
+ String baseUrl,
+ String relativePath,
+ long contentLength,
+ String contentType) |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getBaseUrl()
+Returns the URL to which the originating request was sent.
+ |
+
long |
+getContentLength()
+Returns the number of bytes in the originating request.
+ |
+
String |
+getContentType()
+Returns the content type header value of the originating request.
+ |
+
String |
+getMethod()
+Returns the HTTP method of the originating request.
+ |
+
String |
+getRelativePath()
+Returns the path relative to the base URL to which the originating request was sent.
+ |
+
public String getMethod()+
public String getBaseUrl()+
public String getRelativePath()+
public long getContentLength()+
public String getContentType()+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/Profiler.html b/website/1.x/retrofit/retrofit/Profiler.html new file mode 100644 index 0000000000..5e5acf04b5 --- /dev/null +++ b/website/1.x/retrofit/retrofit/Profiler.html @@ -0,0 +1,288 @@ + + + + + + +public interface Profiler<T>
+| Modifier and Type | +Interface and Description | +
|---|---|
static class |
+Profiler.RequestInformation
+Information about the HTTP request.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+afterCall(Profiler.RequestInformation requestInfo,
+ long elapsedTime,
+ int statusCode,
+ T beforeCallData)
+Invoked after an HTTP method completes.
+ |
+
T |
+beforeCall()
+Invoked before an HTTP method call.
+ |
+
T beforeCall()+
afterCall(retrofit.Profiler.RequestInformation, long, int, T) when the call returns.
+
+ This method gives implementers the opportunity to include information that may
+ change during the server call in afterCall logic.
void afterCall(Profiler.RequestInformation requestInfo, + long elapsedTime, + int statusCode, + T beforeCallData)+
requestInfo - information about the originating HTTP request.elapsedTime - time in milliseconds it took the HTTP request to complete.statusCode - response status code.beforeCallData - the data returned by the corresponding beforeCall().Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/RequestInterceptor.RequestFacade.html b/website/1.x/retrofit/retrofit/RequestInterceptor.RequestFacade.html new file mode 100644 index 0000000000..9542de8a7d --- /dev/null +++ b/website/1.x/retrofit/retrofit/RequestInterceptor.RequestFacade.html @@ -0,0 +1,306 @@ + + + + + + +public static interface RequestInterceptor.RequestFacade
+| Modifier and Type | +Method and Description | +
|---|---|
void |
+addEncodedPathParam(String name,
+ String value)
+Add a path parameter replacement without first URI encoding.
+ |
+
void |
+addEncodedQueryParam(String name,
+ String value)
+Add an additional query parameter without first URI encoding.
+ |
+
void |
+addHeader(String name,
+ String value)
+Add a header to the request.
+ |
+
void |
+addPathParam(String name,
+ String value)
+Add a path parameter replacement.
+ |
+
void |
+addQueryParam(String name,
+ String value)
+Add an additional query parameter.
+ |
+
void addHeader(String name, + String value)+
void addPathParam(String name, + String value)+
@Path-annotated method argument.void addEncodedPathParam(String name, + String value)+
@Path-annotated method argument with encode=false.void addQueryParam(String name, + String value)+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/RequestInterceptor.html b/website/1.x/retrofit/retrofit/RequestInterceptor.html new file mode 100644 index 0000000000..7019540c52 --- /dev/null +++ b/website/1.x/retrofit/retrofit/RequestInterceptor.html @@ -0,0 +1,285 @@ + + + + + + +public interface RequestInterceptor
+| Modifier and Type | +Interface and Description | +
|---|---|
static interface |
+RequestInterceptor.RequestFacade |
+
| Modifier and Type | +Field and Description | +
|---|---|
static RequestInterceptor |
+NONE
+A
+RequestInterceptor which does no modification of requests. |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+intercept(RequestInterceptor.RequestFacade request)
+Called for every request.
+ |
+
static final RequestInterceptor NONE+
RequestInterceptor which does no modification of requests.void intercept(RequestInterceptor.RequestFacade request)+
RequestInterceptor.RequestFacade.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/ResponseCallback.html b/website/1.x/retrofit/retrofit/ResponseCallback.html new file mode 100644 index 0000000000..a33ebb1fb3 --- /dev/null +++ b/website/1.x/retrofit/retrofit/ResponseCallback.html @@ -0,0 +1,313 @@ + + + + + + +| Constructor and Description | +
|---|
ResponseCallback() |
+
| Modifier and Type | +Method and Description | +
|---|---|
abstract void |
+success(Response response)
+Successful HTTP response.
+ |
+
void |
+success(Response response,
+ Response response2)
+Successful HTTP response.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/RestAdapter.Builder.html b/website/1.x/retrofit/retrofit/RestAdapter.Builder.html new file mode 100644 index 0000000000..6fba538fee --- /dev/null +++ b/website/1.x/retrofit/retrofit/RestAdapter.Builder.html @@ -0,0 +1,481 @@ + + + + + + +public static class RestAdapter.Builder +extends Object+
RestAdapter.
+
+ Calling the following methods is required before calling build():
+
+ If you are using asynchronous execution (i.e., with Callbacks) the following
+ is also required:
+
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter |
+build()
+Create the
+RestAdapter instances. |
+
RestAdapter.Builder |
+setClient(Client.Provider clientProvider)
+The HTTP client used for requests.
+ |
+
RestAdapter.Builder |
+setClient(Client client)
+The HTTP client used for requests.
+ |
+
RestAdapter.Builder |
+setConverter(Converter converter)
+The converter used for serialization and deserialization of objects.
+ |
+
RestAdapter.Builder |
+setEndpoint(Endpoint endpoint)
+API endpoint.
+ |
+
RestAdapter.Builder |
+setEndpoint(String endpoint)
+API endpoint URL.
+ |
+
RestAdapter.Builder |
+setErrorHandler(ErrorHandler errorHandler)
+The error handler allows you to customize the type of exception thrown for errors on
+ synchronous requests.
+ |
+
RestAdapter.Builder |
+setExecutors(Executor httpExecutor,
+ Executor callbackExecutor)
+Executors used for asynchronous HTTP client downloads and callbacks.
+ |
+
RestAdapter.Builder |
+setLog(RestAdapter.Log log)
+Configure debug logging mechanism.
+ |
+
RestAdapter.Builder |
+setLogLevel(RestAdapter.LogLevel logLevel)
+Change the level of logging.
+ |
+
RestAdapter.Builder |
+setProfiler(Profiler profiler)
+Set the profiler used to measure requests.
+ |
+
RestAdapter.Builder |
+setRequestInterceptor(RequestInterceptor requestInterceptor)
+A request interceptor for adding data to every request.
+ |
+
public RestAdapter.Builder setEndpoint(String endpoint)+
public RestAdapter.Builder setEndpoint(Endpoint endpoint)+
public RestAdapter.Builder setClient(Client client)+
public RestAdapter.Builder setClient(Client.Provider clientProvider)+
public RestAdapter.Builder setExecutors(Executor httpExecutor, + Executor callbackExecutor)+
httpExecutor - Executor on which HTTP client calls will be made.callbackExecutor - Executor on which any Callback methods will be invoked. If
+ this argument is null then callback methods will be run on the same thread as the
+ HTTP client.public RestAdapter.Builder setRequestInterceptor(RequestInterceptor requestInterceptor)+
public RestAdapter.Builder setConverter(Converter converter)+
public RestAdapter.Builder setProfiler(Profiler profiler)+
public RestAdapter.Builder setErrorHandler(ErrorHandler errorHandler)+
public RestAdapter.Builder setLog(RestAdapter.Log log)+
public RestAdapter.Builder setLogLevel(RestAdapter.LogLevel logLevel)+
public RestAdapter build()+
RestAdapter instances.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/RestAdapter.Log.html b/website/1.x/retrofit/retrofit/RestAdapter.Log.html new file mode 100644 index 0000000000..1dba441531 --- /dev/null +++ b/website/1.x/retrofit/retrofit/RestAdapter.Log.html @@ -0,0 +1,274 @@ + + + + + + +public static interface RestAdapter.Log
+| Modifier and Type | +Field and Description | +
|---|---|
static RestAdapter.Log |
+NONE
+A
+RestAdapter.Log implementation which does not log anything. |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+log(String message)
+Log a debug message to the appropriate console.
+ |
+
static final RestAdapter.Log NONE+
RestAdapter.Log implementation which does not log anything.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/RestAdapter.LogLevel.html b/website/1.x/retrofit/retrofit/RestAdapter.LogLevel.html new file mode 100644 index 0000000000..e1820c671f --- /dev/null +++ b/website/1.x/retrofit/retrofit/RestAdapter.LogLevel.html @@ -0,0 +1,414 @@ + + + + + + +public static enum RestAdapter.LogLevel +extends Enum<RestAdapter.LogLevel>+
| Enum Constant and Description | +
|---|
BASIC
+Log only the request method and URL and the response status code and execution time.
+ |
+
FULL
+Log the headers, body, and metadata for both requests and responses.
+ |
+
HEADERS
+Log the basic information along with request and response headers.
+ |
+
HEADERS_AND_ARGS
+Log the basic information along with request and response objects via toString().
+ |
+
NONE
+No logging.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+log() |
+
static RestAdapter.LogLevel |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static RestAdapter.LogLevel[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final RestAdapter.LogLevel NONE+
public static final RestAdapter.LogLevel BASIC+
public static final RestAdapter.LogLevel HEADERS+
public static final RestAdapter.LogLevel HEADERS_AND_ARGS+
public static final RestAdapter.LogLevel FULL+
+ Note: This requires that the entire request and response body be buffered in memory!
public static RestAdapter.LogLevel[] values()+
+for (RestAdapter.LogLevel c : RestAdapter.LogLevel.values()) + System.out.println(c); +
public static RestAdapter.LogLevel valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullpublic boolean log()+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/RestAdapter.html b/website/1.x/retrofit/retrofit/RestAdapter.html new file mode 100644 index 0000000000..e22bedcc22 --- /dev/null +++ b/website/1.x/retrofit/retrofit/RestAdapter.html @@ -0,0 +1,372 @@ + + + + + + +public class RestAdapter +extends Object+
+ API endpoints are defined as methods on an interface with annotations providing metadata about + the form in which the HTTP call should be made. +
+ The relative path for a given method is obtained from an annotation on the method describing
+ the request type. The built-in methods are GET,
+ PUT, POST, HEAD,
+ and DELETE. You can define your own HTTP method by creating an
+ annotation that takes a {code String} value and itself is annotated with
+ @RestMethod.
+
+ Method parameters can be used to replace parts of the URL by annotating them with
+ @Path. Replacement sections are denoted by an identifier surrounded
+ by curly braces (e.g., "{foo}"). To add items to the query string of a URL use
+ @Query.
+
+ HTTP requests happen in one of two ways: +
Executor with callbacks marshaled to the callback
+ Executor. The last method parameter should be of type Callback. The HTTP
+ response will be converted to the callback's parameter type using the specified
+ Converter. If the callback parameter type uses a wildcard,
+ the lower bound will be used as the conversion type.
+ RetrofitError. The HTTP
+ response will be converted to the method's return type using the specified
+ Converter.
+
+ The body of a request is denoted by the @Body annotation. The object
+ will be converted to request representation by a call to
+ toBody on the supplied
+ Converter for this instance. The body can also be a
+ TypedOutput where it will be used directly.
+
+ Alternative request body formats are supported by method annotations and corresponding parameter + annotations: +
@FormUrlEncoded - Form-encoded data with key-value
+ pairs specified by the @Field parameter annotation.
+ @Multipart - RFC 2387-compliant multi-part data with parts
+ specified by the @Part parameter annotation.
+
+ Additional static headers can be added for an endpoint using the
+ @Headers method annotation. For per-request control over a header
+ annotate a parameter with @Header.
+
+ For example: +
+ public interface MyApi {
+ @POST("/category/{cat}") // Asynchronous execution.
+ void categoryList(@Path("cat") String a, @Query("page") int b,
+ Callback<List<Item>> cb);
+ @POST("/category/{cat}") // Synchronous execution.
+ List<Item> categoryList(@Path("cat") String a, @Query("page") int b);
+ }
+
+
+ Calling create(Class) with MyApi.class will validate and create a new
+ implementation of the API.
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+RestAdapter.Builder
+Build a new
+RestAdapter. |
+
static interface |
+RestAdapter.Log
+Simple logging abstraction for debug messages.
+ |
+
static class |
+RestAdapter.LogLevel
+Controls the level of logging.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T> T |
+create(Class<T> service)
+Create an implementation of the API defined by the specified
+service interface. |
+
RestAdapter.LogLevel |
+getLogLevel()
+The current logging level.
+ |
+
void |
+setLogLevel(RestAdapter.LogLevel loglevel)
+Change the level of logging.
+ |
+
public void setLogLevel(RestAdapter.LogLevel loglevel)+
public RestAdapter.LogLevel getLogLevel()+
public <T> T create(Class<T> service)+
service interface.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/RetrofitError.Kind.html b/website/1.x/retrofit/retrofit/RetrofitError.Kind.html new file mode 100644 index 0000000000..239a2715f0 --- /dev/null +++ b/website/1.x/retrofit/retrofit/RetrofitError.Kind.html @@ -0,0 +1,385 @@ + + + + + + +public static enum RetrofitError.Kind +extends Enum<RetrofitError.Kind>+
RetrofitError.| Enum Constant and Description | +
|---|
CONVERSION
+An exception was thrown while (de)serializing a body.
+ |
+
HTTP
+A non-200 HTTP status code was received from the server.
+ |
+
NETWORK
+An
+IOException occurred while communicating to the server. |
+
UNEXPECTED
+An internal error occurred while attempting to execute a request.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static RetrofitError.Kind |
+valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static RetrofitError.Kind[] |
+values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
public static final RetrofitError.Kind NETWORK+
IOException occurred while communicating to the server.public static final RetrofitError.Kind CONVERSION+
public static final RetrofitError.Kind HTTP+
public static final RetrofitError.Kind UNEXPECTED+
public static RetrofitError.Kind[] values()+
+for (RetrofitError.Kind c : RetrofitError.Kind.values()) + System.out.println(c); +
public static RetrofitError.Kind valueOf(String name)+
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant with the specified nameNullPointerException - if the argument is nullCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/RetrofitError.html b/website/1.x/retrofit/retrofit/RetrofitError.html new file mode 100644 index 0000000000..21743f0011 --- /dev/null +++ b/website/1.x/retrofit/retrofit/RetrofitError.html @@ -0,0 +1,477 @@ + + + + + + +public class RetrofitError +extends RuntimeException+
| Modifier and Type | +Class and Description | +
|---|---|
static class |
+RetrofitError.Kind
+Identifies the event kind which triggered a
+RetrofitError. |
+
| Modifier and Type | +Method and Description | +
|---|---|
static RetrofitError |
+conversionError(String url,
+ Response response,
+ Converter converter,
+ Type successType,
+ ConversionException exception) |
+
Object |
+getBody()
+HTTP response body converted to the type declared by either the interface method return type
+ or the generic type of the supplied
+Callback parameter. |
+
Object |
+getBodyAs(Type type)
+HTTP response body converted to specified
+type. |
+
RetrofitError.Kind |
+getKind()
+The event kind which triggered this error.
+ |
+
Response |
+getResponse()
+Response object containing status code, headers, body, etc.
+ |
+
Type |
+getSuccessType()
+The type declared by either the interface method return type or the generic type of the
+ supplied
+Callback parameter. |
+
String |
+getUrl()
+The request URL which produced the error.
+ |
+
static RetrofitError |
+httpError(String url,
+ Response response,
+ Converter converter,
+ Type successType) |
+
boolean |
+isNetworkError()
+Deprecated.
+
+
+ |
+
static RetrofitError |
+networkError(String url,
+ IOException exception) |
+
static RetrofitError |
+unexpectedError(String url,
+ Throwable exception) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringpublic static RetrofitError networkError(String url, + IOException exception)+
public static RetrofitError conversionError(String url, + Response response, + Converter converter, + Type successType, + ConversionException exception)+
public static RetrofitError httpError(String url, + Response response, + Converter converter, + Type successType)+
public static RetrofitError unexpectedError(String url, + Throwable exception)+
public String getUrl()+
public Response getResponse()+
@Deprecated +public boolean isNetworkError()+
getKind() == Kind.NETWORK.public RetrofitError.Kind getKind()+
public Object getBody()+
Callback parameter. null if there is no
+ response.RuntimeException - if unable to convert the body to the success
+ type.public Type getSuccessType()+
Callback parameter.public Object getBodyAs(Type type)+
type. null if there is no response.RuntimeException - if unable to convert the body to the specified type.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/android/AndroidApacheClient.html b/website/1.x/retrofit/retrofit/android/AndroidApacheClient.html new file mode 100644 index 0000000000..8e5d321a40 --- /dev/null +++ b/website/1.x/retrofit/retrofit/android/AndroidApacheClient.html @@ -0,0 +1,275 @@ + + + + + + +public final class AndroidApacheClient +extends ApacheClient+
Client which uses the Android-specific version of
+ HttpClient, AndroidHttpClient.
+
+ If you need to provide a customized version of the AndroidHttpClient or a different
+ HttpClient on Android use ApacheClient directly.
Client.Provider| Constructor and Description | +
|---|
AndroidApacheClient() |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/android/AndroidLog.html b/website/1.x/retrofit/retrofit/android/AndroidLog.html new file mode 100644 index 0000000000..329279725e --- /dev/null +++ b/website/1.x/retrofit/retrofit/android/AndroidLog.html @@ -0,0 +1,332 @@ + + + + + + +public class AndroidLog +extends Object +implements RestAdapter.Log+
logger for Android.NONE| Constructor and Description | +
|---|
AndroidLog(String tag) |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+getTag() |
+
void |
+log(String message)
+Log a debug message to the appropriate console.
+ |
+
void |
+logChunk(String chunk)
+Called one or more times for each call to
+log(String). |
+
public final void log(String message)+
RestAdapter.Loglog in interface RestAdapter.Logpublic void logChunk(String chunk)+
log(String). The length of chunk
+ will be no more than 4000 characters to support Android's Log class.public String getTag()+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/android/MainThreadExecutor.html b/website/1.x/retrofit/retrofit/android/MainThreadExecutor.html new file mode 100644 index 0000000000..2f2a55eaa2 --- /dev/null +++ b/website/1.x/retrofit/retrofit/android/MainThreadExecutor.html @@ -0,0 +1,283 @@ + + + + + + +| Constructor and Description | +
|---|
MainThreadExecutor() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+execute(Runnable r) |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/android/class-use/AndroidApacheClient.html b/website/1.x/retrofit/retrofit/android/class-use/AndroidApacheClient.html new file mode 100644 index 0000000000..afa3064f30 --- /dev/null +++ b/website/1.x/retrofit/retrofit/android/class-use/AndroidApacheClient.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/android/class-use/AndroidLog.html b/website/1.x/retrofit/retrofit/android/class-use/AndroidLog.html new file mode 100644 index 0000000000..2770626a6f --- /dev/null +++ b/website/1.x/retrofit/retrofit/android/class-use/AndroidLog.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/android/class-use/MainThreadExecutor.html b/website/1.x/retrofit/retrofit/android/class-use/MainThreadExecutor.html new file mode 100644 index 0000000000..e4604a958d --- /dev/null +++ b/website/1.x/retrofit/retrofit/android/class-use/MainThreadExecutor.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/android/package-frame.html b/website/1.x/retrofit/retrofit/android/package-frame.html new file mode 100644 index 0000000000..3b42c2808e --- /dev/null +++ b/website/1.x/retrofit/retrofit/android/package-frame.html @@ -0,0 +1,23 @@ + + + + + + +| Class | +Description | +
|---|---|
| AndroidApacheClient | ++ + | +
| AndroidLog | +
+ A
+logger for Android. |
+
| MainThreadExecutor | +
+ Executor that runs tasks on Android's main thread.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/android/package-tree.html b/website/1.x/retrofit/retrofit/android/package-tree.html new file mode 100644 index 0000000000..7ef23861ea --- /dev/null +++ b/website/1.x/retrofit/retrofit/android/package-tree.html @@ -0,0 +1,145 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/android/package-use.html b/website/1.x/retrofit/retrofit/android/package-use.html new file mode 100644 index 0000000000..d07bc1c3b9 --- /dev/null +++ b/website/1.x/retrofit/retrofit/android/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/appengine/UrlFetchClient.html b/website/1.x/retrofit/retrofit/appengine/UrlFetchClient.html new file mode 100644 index 0000000000..5390c2065d --- /dev/null +++ b/website/1.x/retrofit/retrofit/appengine/UrlFetchClient.html @@ -0,0 +1,346 @@ + + + + + + +Client.Provider| Constructor and Description | +
|---|
UrlFetchClient() |
+
UrlFetchClient(com.google.appengine.api.urlfetch.URLFetchService urlFetchService) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Response |
+execute(Request request)
+Synchronously execute an HTTP represented by
+request and encapsulate all response data
+ into a Response instance. |
+
protected com.google.appengine.api.urlfetch.HTTPResponse |
+execute(com.google.appengine.api.urlfetch.URLFetchService urlFetchService,
+ com.google.appengine.api.urlfetch.HTTPRequest request)
+Execute the specified
+request using the provided urlFetchService. |
+
public UrlFetchClient()+
public UrlFetchClient(com.google.appengine.api.urlfetch.URLFetchService urlFetchService)+
public Response execute(Request request) + throws IOException+
Clientrequest and encapsulate all response data
+ into a Response instance.
+
+ Note: If the request has a body, its length and mime type will have already been added to the
+ header list as Content-Length and Content-Type, respectively. Do NOT alter
+ these values as they might have been set as a result of an application-level configuration.
execute in interface ClientIOExceptionprotected com.google.appengine.api.urlfetch.HTTPResponse execute(com.google.appengine.api.urlfetch.URLFetchService urlFetchService, + com.google.appengine.api.urlfetch.HTTPRequest request) + throws IOException+
request using the provided urlFetchService.IOExceptionCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/appengine/class-use/UrlFetchClient.html b/website/1.x/retrofit/retrofit/appengine/class-use/UrlFetchClient.html new file mode 100644 index 0000000000..c2465dd741 --- /dev/null +++ b/website/1.x/retrofit/retrofit/appengine/class-use/UrlFetchClient.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/appengine/package-frame.html b/website/1.x/retrofit/retrofit/appengine/package-frame.html new file mode 100644 index 0000000000..2faded6861 --- /dev/null +++ b/website/1.x/retrofit/retrofit/appengine/package-frame.html @@ -0,0 +1,21 @@ + + + + + + +| Class | +Description | +
|---|---|
| UrlFetchClient | +
+ A
+Client for Google AppEngine's which uses its URLFetchService. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/appengine/package-tree.html b/website/1.x/retrofit/retrofit/appengine/package-tree.html new file mode 100644 index 0000000000..e1dbefcc41 --- /dev/null +++ b/website/1.x/retrofit/retrofit/appengine/package-tree.html @@ -0,0 +1,139 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/appengine/package-use.html b/website/1.x/retrofit/retrofit/appengine/package-use.html new file mode 100644 index 0000000000..785e70aea2 --- /dev/null +++ b/website/1.x/retrofit/retrofit/appengine/package-use.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/Callback.html b/website/1.x/retrofit/retrofit/class-use/Callback.html new file mode 100644 index 0000000000..64ce07a24f --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/Callback.html @@ -0,0 +1,171 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ResponseCallback
+An extension of
+Callback which returns only Response object
+ in success(Object, retrofit.client.Response) method. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/Endpoint.html b/website/1.x/retrofit/retrofit/class-use/Endpoint.html new file mode 100644 index 0000000000..04f4dfa601 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/Endpoint.html @@ -0,0 +1,192 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static Endpoint |
+Endpoints.newFixedEndpoint(String url)
+Create a server with the provided URL.
+ |
+
static Endpoint |
+Endpoints.newFixedEndpoint(String url,
+ String name)
+Create an endpoint with the provided URL and name.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter.Builder |
+RestAdapter.Builder.setEndpoint(Endpoint endpoint)
+API endpoint.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/Endpoints.html b/website/1.x/retrofit/retrofit/class-use/Endpoints.html new file mode 100644 index 0000000000..fd9de184a9 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/Endpoints.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/ErrorHandler.html b/website/1.x/retrofit/retrofit/class-use/ErrorHandler.html new file mode 100644 index 0000000000..b7fc60ab28 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/ErrorHandler.html @@ -0,0 +1,186 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static ErrorHandler |
+ErrorHandler.DEFAULT
+An
+ErrorHandler which returns the original error. |
+
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter.Builder |
+RestAdapter.Builder.setErrorHandler(ErrorHandler errorHandler)
+The error handler allows you to customize the type of exception thrown for errors on
+ synchronous requests.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/Profiler.RequestInformation.html b/website/1.x/retrofit/retrofit/class-use/Profiler.RequestInformation.html new file mode 100644 index 0000000000..d5b6ec78d5 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/Profiler.RequestInformation.html @@ -0,0 +1,173 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Profiler.afterCall(Profiler.RequestInformation requestInfo,
+ long elapsedTime,
+ int statusCode,
+ T beforeCallData)
+Invoked after an HTTP method completes.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/Profiler.html b/website/1.x/retrofit/retrofit/class-use/Profiler.html new file mode 100644 index 0000000000..962feb1392 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/Profiler.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter.Builder |
+RestAdapter.Builder.setProfiler(Profiler profiler)
+Set the profiler used to measure requests.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/RequestInterceptor.RequestFacade.html b/website/1.x/retrofit/retrofit/class-use/RequestInterceptor.RequestFacade.html new file mode 100644 index 0000000000..8aafd855fd --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/RequestInterceptor.RequestFacade.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+RequestInterceptor.intercept(RequestInterceptor.RequestFacade request)
+Called for every request.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/RequestInterceptor.html b/website/1.x/retrofit/retrofit/class-use/RequestInterceptor.html new file mode 100644 index 0000000000..58d9cceaa0 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/RequestInterceptor.html @@ -0,0 +1,185 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Field and Description | +
|---|---|
static RequestInterceptor |
+RequestInterceptor.NONE
+A
+RequestInterceptor which does no modification of requests. |
+
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter.Builder |
+RestAdapter.Builder.setRequestInterceptor(RequestInterceptor requestInterceptor)
+A request interceptor for adding data to every request.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/ResponseCallback.html b/website/1.x/retrofit/retrofit/class-use/ResponseCallback.html new file mode 100644 index 0000000000..15c00ae208 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/ResponseCallback.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/RestAdapter.Builder.html b/website/1.x/retrofit/retrofit/class-use/RestAdapter.Builder.html new file mode 100644 index 0000000000..92b309e820 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/RestAdapter.Builder.html @@ -0,0 +1,232 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter.Builder |
+RestAdapter.Builder.setClient(Client.Provider clientProvider)
+The HTTP client used for requests.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setClient(Client client)
+The HTTP client used for requests.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setConverter(Converter converter)
+The converter used for serialization and deserialization of objects.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setEndpoint(Endpoint endpoint)
+API endpoint.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setEndpoint(String endpoint)
+API endpoint URL.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setErrorHandler(ErrorHandler errorHandler)
+The error handler allows you to customize the type of exception thrown for errors on
+ synchronous requests.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setExecutors(Executor httpExecutor,
+ Executor callbackExecutor)
+Executors used for asynchronous HTTP client downloads and callbacks.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setLog(RestAdapter.Log log)
+Configure debug logging mechanism.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setLogLevel(RestAdapter.LogLevel logLevel)
+Change the level of logging.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setProfiler(Profiler profiler)
+Set the profiler used to measure requests.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setRequestInterceptor(RequestInterceptor requestInterceptor)
+A request interceptor for adding data to every request.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/RestAdapter.Log.html b/website/1.x/retrofit/retrofit/class-use/RestAdapter.Log.html new file mode 100644 index 0000000000..41a11fd291 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/RestAdapter.Log.html @@ -0,0 +1,209 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| retrofit.android | ++ |
| Modifier and Type | +Field and Description | +
|---|---|
static RestAdapter.Log |
+RestAdapter.Log.NONE
+A
+RestAdapter.Log implementation which does not log anything. |
+
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter.Builder |
+RestAdapter.Builder.setLog(RestAdapter.Log log)
+Configure debug logging mechanism.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AndroidLog
+A
+logger for Android. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/RestAdapter.LogLevel.html b/website/1.x/retrofit/retrofit/class-use/RestAdapter.LogLevel.html new file mode 100644 index 0000000000..a4fc92d82a --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/RestAdapter.LogLevel.html @@ -0,0 +1,204 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter.LogLevel |
+RestAdapter.getLogLevel()
+The current logging level.
+ |
+
static RestAdapter.LogLevel |
+RestAdapter.LogLevel.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static RestAdapter.LogLevel[] |
+RestAdapter.LogLevel.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+RestAdapter.setLogLevel(RestAdapter.LogLevel loglevel)
+Change the level of logging.
+ |
+
RestAdapter.Builder |
+RestAdapter.Builder.setLogLevel(RestAdapter.LogLevel logLevel)
+Change the level of logging.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/RestAdapter.html b/website/1.x/retrofit/retrofit/class-use/RestAdapter.html new file mode 100644 index 0000000000..5e8cb75523 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/RestAdapter.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter |
+RestAdapter.Builder.build()
+Create the
+RestAdapter instances. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/RetrofitError.Kind.html b/website/1.x/retrofit/retrofit/class-use/RetrofitError.Kind.html new file mode 100644 index 0000000000..123d8d56b9 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/RetrofitError.Kind.html @@ -0,0 +1,183 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RetrofitError.Kind |
+RetrofitError.getKind()
+The event kind which triggered this error.
+ |
+
static RetrofitError.Kind |
+RetrofitError.Kind.valueOf(String name)
+Returns the enum constant of this type with the specified name.
+ |
+
static RetrofitError.Kind[] |
+RetrofitError.Kind.values()
+Returns an array containing the constants of this enum type, in
+the order they are declared.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/class-use/RetrofitError.html b/website/1.x/retrofit/retrofit/class-use/RetrofitError.html new file mode 100644 index 0000000000..e879c9d099 --- /dev/null +++ b/website/1.x/retrofit/retrofit/class-use/RetrofitError.html @@ -0,0 +1,211 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static RetrofitError |
+RetrofitError.conversionError(String url,
+ Response response,
+ Converter converter,
+ Type successType,
+ ConversionException exception) |
+
static RetrofitError |
+RetrofitError.httpError(String url,
+ Response response,
+ Converter converter,
+ Type successType) |
+
static RetrofitError |
+RetrofitError.networkError(String url,
+ IOException exception) |
+
static RetrofitError |
+RetrofitError.unexpectedError(String url,
+ Throwable exception) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Callback.failure(RetrofitError error)
+Unsuccessful HTTP response due to network failure, non-2XX status code, or unexpected
+ exception.
+ |
+
Throwable |
+ErrorHandler.handleError(RetrofitError cause)
+Return a custom exception to be thrown for a
+RetrofitError. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/ApacheClient.html b/website/1.x/retrofit/retrofit/client/ApacheClient.html new file mode 100644 index 0000000000..004f2eb8c5 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/ApacheClient.html @@ -0,0 +1,353 @@ + + + + + + +public class ApacheClient +extends Object +implements Client+
Client which uses an implementation of Apache's HttpClient.Client.Provider| Constructor and Description | +
|---|
ApacheClient()
+Creates an instance backed by
+DefaultHttpClient. |
+
ApacheClient(org.apache.http.client.HttpClient client) |
+
| Modifier and Type | +Method and Description | +
|---|---|
protected org.apache.http.HttpResponse |
+execute(org.apache.http.client.HttpClient client,
+ org.apache.http.client.methods.HttpUriRequest request)
+Execute the specified
+request using the provided client. |
+
Response |
+execute(Request request)
+Synchronously execute an HTTP represented by
+request and encapsulate all response data
+ into a Response instance. |
+
public ApacheClient()+
DefaultHttpClient.public ApacheClient(org.apache.http.client.HttpClient client)+
public Response execute(Request request) + throws IOException+
Clientrequest and encapsulate all response data
+ into a Response instance.
+
+ Note: If the request has a body, its length and mime type will have already been added to the
+ header list as Content-Length and Content-Type, respectively. Do NOT alter
+ these values as they might have been set as a result of an application-level configuration.
execute in interface ClientIOExceptionprotected org.apache.http.HttpResponse execute(org.apache.http.client.HttpClient client, + org.apache.http.client.methods.HttpUriRequest request) + throws IOException+
request using the provided client.IOExceptionCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/Client.Provider.html b/website/1.x/retrofit/retrofit/client/Client.Provider.html new file mode 100644 index 0000000000..53922f2c3c --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/Client.Provider.html @@ -0,0 +1,232 @@ + + + + + + +| Modifier and Type | +Method and Description | +
|---|---|
Client |
+get()
+Obtain an HTTP client.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/Client.html b/website/1.x/retrofit/retrofit/client/Client.html new file mode 100644 index 0000000000..104336a518 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/Client.html @@ -0,0 +1,264 @@ + + + + + + +public interface Client
+Requests. This class must be
+ thread-safe as invocation may happen from multiple threads simultaneously.| Modifier and Type | +Interface and Description | +
|---|---|
static interface |
+Client.Provider
+Deferred means of obtaining a
+Client. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Response |
+execute(Request request)
+Synchronously execute an HTTP represented by
+request and encapsulate all response data
+ into a Response instance. |
+
Response execute(Request request) + throws IOException+
request and encapsulate all response data
+ into a Response instance.
+
+ Note: If the request has a body, its length and mime type will have already been added to the
+ header list as Content-Length and Content-Type, respectively. Do NOT alter
+ these values as they might have been set as a result of an application-level configuration.
IOExceptionCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/Header.html b/website/1.x/retrofit/retrofit/client/Header.html new file mode 100644 index 0000000000..5f2478cfc6 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/Header.html @@ -0,0 +1,340 @@ + + + + + + +public final class Header +extends Object+
| Constructor and Description | +
|---|
Header(String name,
+ String value) |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/OkClient.html b/website/1.x/retrofit/retrofit/client/OkClient.html new file mode 100644 index 0000000000..d6c45cc7a6 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/OkClient.html @@ -0,0 +1,323 @@ + + + + + + +Client.Provider| Constructor and Description | +
|---|
OkClient() |
+
OkClient(com.squareup.okhttp.OkHttpClient client) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Response |
+execute(Request request)
+Synchronously execute an HTTP represented by
+request and encapsulate all response data
+ into a Response instance. |
+
public OkClient()+
public OkClient(com.squareup.okhttp.OkHttpClient client)+
public Response execute(Request request) + throws IOException+
Clientrequest and encapsulate all response data
+ into a Response instance.
+
+ Note: If the request has a body, its length and mime type will have already been added to the
+ header list as Content-Length and Content-Type, respectively. Do NOT alter
+ these values as they might have been set as a result of an application-level configuration.
execute in interface ClientIOExceptionCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/Request.html b/website/1.x/retrofit/retrofit/client/Request.html new file mode 100644 index 0000000000..5fd53e33bf --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/Request.html @@ -0,0 +1,331 @@ + + + + + + +public final class Request +extends Object+
| Constructor and Description | +
|---|
Request(String method,
+ String url,
+ List<Header> headers,
+ TypedOutput body) |
+
| Modifier and Type | +Method and Description | +
|---|---|
TypedOutput |
+getBody()
+Returns the request body or
+null. |
+
List<Header> |
+getHeaders()
+Returns an unmodifiable list of headers, never
+null. |
+
String |
+getMethod()
+HTTP method verb.
+ |
+
String |
+getUrl()
+Target URL.
+ |
+
public Request(String method, + String url, + List<Header> headers, + TypedOutput body)+
public String getMethod()+
public String getUrl()+
public List<Header> getHeaders()+
null.public TypedOutput getBody()+
null.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/Response.html b/website/1.x/retrofit/retrofit/client/Response.html new file mode 100644 index 0000000000..55561caaa6 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/Response.html @@ -0,0 +1,353 @@ + + + + + + +public final class Response +extends Object+
+ When used directly as a data type for an interface method, the response body is buffered to a
+ byte[]. Annotate the method with @Streaming for an
+ unbuffered stream from the network.
| Constructor and Description | +
|---|
Response(String url,
+ int status,
+ String reason,
+ List<Header> headers,
+ TypedInput body) |
+
| Modifier and Type | +Method and Description | +
|---|---|
TypedInput |
+getBody()
+Response body.
+ |
+
List<Header> |
+getHeaders()
+An unmodifiable collection of headers.
+ |
+
String |
+getReason()
+Status line reason phrase.
+ |
+
int |
+getStatus()
+Status line code.
+ |
+
String |
+getUrl()
+Request URL.
+ |
+
public Response(String url, + int status, + String reason, + List<Header> headers, + TypedInput body)+
public String getUrl()+
public int getStatus()+
public String getReason()+
public TypedInput getBody()+
null.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/UrlConnectionClient.html b/website/1.x/retrofit/retrofit/client/UrlConnectionClient.html new file mode 100644 index 0000000000..137b5fa60f --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/UrlConnectionClient.html @@ -0,0 +1,329 @@ + + + + + + +public class UrlConnectionClient +extends Object +implements Client+
HttpURLConnection for communication.Client.Provider| Constructor and Description | +
|---|
UrlConnectionClient() |
+
| Modifier and Type | +Method and Description | +
|---|---|
Response |
+execute(Request request)
+Synchronously execute an HTTP represented by
+request and encapsulate all response data
+ into a Response instance. |
+
protected HttpURLConnection |
+openConnection(Request request) |
+
public Response execute(Request request) + throws IOException+
Clientrequest and encapsulate all response data
+ into a Response instance.
+
+ Note: If the request has a body, its length and mime type will have already been added to the
+ header list as Content-Length and Content-Type, respectively. Do NOT alter
+ these values as they might have been set as a result of an application-level configuration.
execute in interface ClientIOExceptionprotected HttpURLConnection openConnection(Request request) + throws IOException+
IOExceptionCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/class-use/ApacheClient.html b/website/1.x/retrofit/retrofit/client/class-use/ApacheClient.html new file mode 100644 index 0000000000..b7205966ab --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/class-use/ApacheClient.html @@ -0,0 +1,169 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit.android | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AndroidApacheClient
+
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/class-use/Client.Provider.html b/website/1.x/retrofit/retrofit/client/class-use/Client.Provider.html new file mode 100644 index 0000000000..17f569d130 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/class-use/Client.Provider.html @@ -0,0 +1,170 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter.Builder |
+RestAdapter.Builder.setClient(Client.Provider clientProvider)
+The HTTP client used for requests.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/class-use/Client.html b/website/1.x/retrofit/retrofit/client/class-use/Client.html new file mode 100644 index 0000000000..69cb980520 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/class-use/Client.html @@ -0,0 +1,270 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| retrofit.android | ++ |
| retrofit.appengine | ++ |
| retrofit.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
RestAdapter.Builder |
+RestAdapter.Builder.setClient(Client client)
+The HTTP client used for requests.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+AndroidApacheClient
+
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+UrlFetchClient
+A
+Client for Google AppEngine's which uses its URLFetchService. |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+ApacheClient
+A
+Client which uses an implementation of Apache's HttpClient. |
+
class |
+OkClient
+Retrofit client that uses OkHttp for communication.
+ |
+
class |
+UrlConnectionClient
+Retrofit client that uses
+HttpURLConnection for communication. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Client |
+Client.Provider.get()
+Obtain an HTTP client.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/class-use/Header.html b/website/1.x/retrofit/retrofit/client/class-use/Header.html new file mode 100644 index 0000000000..d1d48ef6b9 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/class-use/Header.html @@ -0,0 +1,195 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
List<Header> |
+Response.getHeaders()
+An unmodifiable collection of headers.
+ |
+
List<Header> |
+Request.getHeaders()
+Returns an unmodifiable list of headers, never
+null. |
+
| Constructor and Description | +
|---|
Request(String method,
+ String url,
+ List<Header> headers,
+ TypedOutput body) |
+
Response(String url,
+ int status,
+ String reason,
+ List<Header> headers,
+ TypedInput body) |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/class-use/OkClient.html b/website/1.x/retrofit/retrofit/client/class-use/OkClient.html new file mode 100644 index 0000000000..cfa85be9c7 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/class-use/OkClient.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/class-use/Request.html b/website/1.x/retrofit/retrofit/client/class-use/Request.html new file mode 100644 index 0000000000..3a67a0ddfa --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/class-use/Request.html @@ -0,0 +1,207 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit.appengine | ++ |
| retrofit.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Response |
+UrlFetchClient.execute(Request request) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Response |
+UrlConnectionClient.execute(Request request) |
+
Response |
+OkClient.execute(Request request) |
+
Response |
+Client.execute(Request request)
+Synchronously execute an HTTP represented by
+request and encapsulate all response data
+ into a Response instance. |
+
Response |
+ApacheClient.execute(Request request) |
+
protected HttpURLConnection |
+UrlConnectionClient.openConnection(Request request) |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/class-use/Response.html b/website/1.x/retrofit/retrofit/client/class-use/Response.html new file mode 100644 index 0000000000..aef75e0e16 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/class-use/Response.html @@ -0,0 +1,271 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| retrofit.appengine | ++ |
| retrofit.client | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
Response |
+RetrofitError.getResponse()
+Response object containing status code, headers, body, etc.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
static RetrofitError |
+RetrofitError.conversionError(String url,
+ Response response,
+ Converter converter,
+ Type successType,
+ ConversionException exception) |
+
static RetrofitError |
+RetrofitError.httpError(String url,
+ Response response,
+ Converter converter,
+ Type successType) |
+
abstract void |
+ResponseCallback.success(Response response)
+Successful HTTP response.
+ |
+
void |
+ResponseCallback.success(Response response,
+ Response response2) |
+
void |
+Callback.success(T t,
+ Response response)
+Successful HTTP response.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
Response |
+UrlFetchClient.execute(Request request) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Response |
+UrlConnectionClient.execute(Request request) |
+
Response |
+OkClient.execute(Request request) |
+
Response |
+Client.execute(Request request)
+Synchronously execute an HTTP represented by
+request and encapsulate all response data
+ into a Response instance. |
+
Response |
+ApacheClient.execute(Request request) |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/class-use/UrlConnectionClient.html b/website/1.x/retrofit/retrofit/client/class-use/UrlConnectionClient.html new file mode 100644 index 0000000000..f96fa44989 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/class-use/UrlConnectionClient.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/package-frame.html b/website/1.x/retrofit/retrofit/client/package-frame.html new file mode 100644 index 0000000000..1f4ed2f89d --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/package-frame.html @@ -0,0 +1,31 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Client | +
+ Abstraction of an HTTP client which can execute
+Requests. |
+
| Client.Provider | +
+ Deferred means of obtaining a
+Client. |
+
| Class | +Description | +
|---|---|
| ApacheClient | +
+ A
+Client which uses an implementation of Apache's HttpClient. |
+
| Header | +
+ Represents an HTTP header name/value pair.
+ |
+
| OkClient | +
+ Retrofit client that uses OkHttp for communication.
+ |
+
| Request | +
+ Encapsulates all of the information necessary to make an HTTP request.
+ |
+
| Response | +
+ An HTTP response.
+ |
+
| UrlConnectionClient | +
+ Retrofit client that uses
+HttpURLConnection for communication. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/package-tree.html b/website/1.x/retrofit/retrofit/client/package-tree.html new file mode 100644 index 0000000000..4322eb2c76 --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/package-tree.html @@ -0,0 +1,149 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/client/package-use.html b/website/1.x/retrofit/retrofit/client/package-use.html new file mode 100644 index 0000000000..7f3a667e4b --- /dev/null +++ b/website/1.x/retrofit/retrofit/client/package-use.html @@ -0,0 +1,266 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| retrofit.android | ++ |
| retrofit.appengine | ++ |
| retrofit.client | ++ |
| Class and Description | +
|---|
| Client
+ Abstraction of an HTTP client which can execute
+Requests. |
+
| Client.Provider
+ Deferred means of obtaining a
+Client. |
+
| Response
+ An HTTP response.
+ |
+
| Class and Description | +
|---|
| ApacheClient
+ A
+Client which uses an implementation of Apache's HttpClient. |
+
| Client
+ Abstraction of an HTTP client which can execute
+Requests. |
+
| Class and Description | +
|---|
| Client
+ Abstraction of an HTTP client which can execute
+Requests. |
+
| Request
+ Encapsulates all of the information necessary to make an HTTP request.
+ |
+
| Response
+ An HTTP response.
+ |
+
| Class and Description | +
|---|
| Client
+ Abstraction of an HTTP client which can execute
+Requests. |
+
| Header
+ Represents an HTTP header name/value pair.
+ |
+
| Request
+ Encapsulates all of the information necessary to make an HTTP request.
+ |
+
| Response
+ An HTTP response.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/converter/ConversionException.html b/website/1.x/retrofit/retrofit/converter/ConversionException.html new file mode 100644 index 0000000000..3edc435851 --- /dev/null +++ b/website/1.x/retrofit/retrofit/converter/ConversionException.html @@ -0,0 +1,291 @@ + + + + + + +public class ConversionException +extends Exception+
| Constructor and Description | +
|---|
ConversionException(String message) |
+
ConversionException(String message,
+ Throwable throwable) |
+
ConversionException(Throwable throwable) |
+
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/converter/Converter.html b/website/1.x/retrofit/retrofit/converter/Converter.html new file mode 100644 index 0000000000..cbab479999 --- /dev/null +++ b/website/1.x/retrofit/retrofit/converter/Converter.html @@ -0,0 +1,272 @@ + + + + + + +public interface Converter
+| Modifier and Type | +Method and Description | +
|---|---|
Object |
+fromBody(TypedInput body,
+ Type type)
+Convert an HTTP response body to a concrete object of the specified type.
+ |
+
TypedOutput |
+toBody(Object object)
+Convert an object to an appropriate representation for HTTP transport.
+ |
+
Object fromBody(TypedInput body, + Type type) + throws ConversionException+
body - HTTP response body.type - Target object type.type which will be cast by the caller.ConversionException - if conversion was unable to complete. This will trigger a call to
+ Callback.failure(retrofit.RetrofitError) or throw a
+ RetrofitError. The exception message should report all necessary information
+ about its cause as the response body will be set to null.TypedOutput toBody(Object object)+
object - Object instance to convert.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/converter/GsonConverter.html b/website/1.x/retrofit/retrofit/converter/GsonConverter.html new file mode 100644 index 0000000000..971b2d3f1f --- /dev/null +++ b/website/1.x/retrofit/retrofit/converter/GsonConverter.html @@ -0,0 +1,351 @@ + + + + + + +| Constructor and Description | +
|---|
GsonConverter(com.google.gson.Gson gson)
+Create an instance using the supplied
+Gson object for conversion. |
+
GsonConverter(com.google.gson.Gson gson,
+ String charset)
+Create an instance using the supplied
+Gson object for conversion. |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+fromBody(TypedInput body,
+ Type type)
+Convert an HTTP response body to a concrete object of the specified type.
+ |
+
TypedOutput |
+toBody(Object object)
+Convert an object to an appropriate representation for HTTP transport.
+ |
+
public GsonConverter(com.google.gson.Gson gson)+
Gson object for conversion. Encoding to JSON and
+ decoding from JSON (when no charset is specified by a header) will use UTF-8.public GsonConverter(com.google.gson.Gson gson, + String charset)+
Gson object for conversion. Encoding to JSON and
+ decoding from JSON (when no charset is specified by a header) will use the specified charset.public Object fromBody(TypedInput body, + Type type) + throws ConversionException+
ConverterfromBody in interface Converterbody - HTTP response body.type - Target object type.type which will be cast by the caller.ConversionException - if conversion was unable to complete. This will trigger a call to
+ Callback.failure(retrofit.RetrofitError) or throw a
+ RetrofitError. The exception message should report all necessary information
+ about its cause as the response body will be set to null.public TypedOutput toBody(Object object)+
ConverterCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/converter/class-use/ConversionException.html b/website/1.x/retrofit/retrofit/converter/class-use/ConversionException.html new file mode 100644 index 0000000000..b84b64e774 --- /dev/null +++ b/website/1.x/retrofit/retrofit/converter/class-use/ConversionException.html @@ -0,0 +1,202 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| retrofit.converter | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static RetrofitError |
+RetrofitError.conversionError(String url,
+ Response response,
+ Converter converter,
+ Type successType,
+ ConversionException exception) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+GsonConverter.fromBody(TypedInput body,
+ Type type) |
+
Object |
+Converter.fromBody(TypedInput body,
+ Type type)
+Convert an HTTP response body to a concrete object of the specified type.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/converter/class-use/Converter.html b/website/1.x/retrofit/retrofit/converter/class-use/Converter.html new file mode 100644 index 0000000000..cdd64733e1 --- /dev/null +++ b/website/1.x/retrofit/retrofit/converter/class-use/Converter.html @@ -0,0 +1,209 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| retrofit.converter | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
static RetrofitError |
+RetrofitError.conversionError(String url,
+ Response response,
+ Converter converter,
+ Type successType,
+ ConversionException exception) |
+
static RetrofitError |
+RetrofitError.httpError(String url,
+ Response response,
+ Converter converter,
+ Type successType) |
+
RestAdapter.Builder |
+RestAdapter.Builder.setConverter(Converter converter)
+The converter used for serialization and deserialization of objects.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+GsonConverter
+A
+Converter which uses GSON for serialization and deserialization of entities. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/converter/class-use/GsonConverter.html b/website/1.x/retrofit/retrofit/converter/class-use/GsonConverter.html new file mode 100644 index 0000000000..b7c1762a29 --- /dev/null +++ b/website/1.x/retrofit/retrofit/converter/class-use/GsonConverter.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/converter/package-frame.html b/website/1.x/retrofit/retrofit/converter/package-frame.html new file mode 100644 index 0000000000..dca4e62942 --- /dev/null +++ b/website/1.x/retrofit/retrofit/converter/package-frame.html @@ -0,0 +1,29 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Converter | +
+ Arbiter for converting objects to and from their representation in HTTP.
+ |
+
| Class | +Description | +
|---|---|
| GsonConverter | +
+ A
+Converter which uses GSON for serialization and deserialization of entities. |
+
| Exception | +Description | +
|---|---|
| ConversionException | +
+ Indicate that conversion was unable to complete successfully.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/converter/package-tree.html b/website/1.x/retrofit/retrofit/converter/package-tree.html new file mode 100644 index 0000000000..74fb9f603b --- /dev/null +++ b/website/1.x/retrofit/retrofit/converter/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/converter/package-use.html b/website/1.x/retrofit/retrofit/converter/package-use.html new file mode 100644 index 0000000000..5067c8846e --- /dev/null +++ b/website/1.x/retrofit/retrofit/converter/package-use.html @@ -0,0 +1,194 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| retrofit.converter | ++ |
| Class and Description | +
|---|
| ConversionException
+ Indicate that conversion was unable to complete successfully.
+ |
+
| Converter
+ Arbiter for converting objects to and from their representation in HTTP.
+ |
+
| Class and Description | +
|---|
| ConversionException
+ Indicate that conversion was unable to complete successfully.
+ |
+
| Converter
+ Arbiter for converting objects to and from their representation in HTTP.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/Body.html b/website/1.x/retrofit/retrofit/http/Body.html new file mode 100644 index 0000000000..bd34b500b3 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/Body.html @@ -0,0 +1,182 @@ + + + + + + +@Documented + @Target(value=PARAMETER) + @Retention(value=RUNTIME) +public @interface Body+
TypedOutput,
+ the request body will be written exactly as specified by
+ TypedOutput.writeTo(java.io.OutputStream). If the value does not implement
+ TypedOutput, the object will be serialized using the RestAdapter's
+ Converter and the result will be set directly as the
+ request body.
+
+ Body parameters may not be null.
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/DELETE.html b/website/1.x/retrofit/retrofit/http/DELETE.html new file mode 100644 index 0000000000..f520607a63 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/DELETE.html @@ -0,0 +1,218 @@ + + + + + + +@Documented + @Target(value=METHOD) + @Retention(value=RUNTIME) + @RestMethod(value="DELETE") +public @interface DELETE+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/EncodedPath.html b/website/1.x/retrofit/retrofit/http/EncodedPath.html new file mode 100644 index 0000000000..61f26297fe --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/EncodedPath.html @@ -0,0 +1,237 @@ + + + + + + +Path with encode = false.@Documented + @Deprecated + @Retention(value=RUNTIME) + @Target(value=PARAMETER) +public @interface EncodedPath+
String.valueOf(Object). Values are used literally without URL encoding. See
+ @Path for URL encoding equivalent.
+ +
+ @GET("/image/{id}")
+ void example(@EncodedPath("id") int id, ..);
+
+
+ Path parameters may not be null.
PathCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/EncodedQuery.html b/website/1.x/retrofit/retrofit/http/EncodedQuery.html new file mode 100644 index 0000000000..cb9247f749 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/EncodedQuery.html @@ -0,0 +1,233 @@ + + + + + + +Query with encodeValue = false.@Documented + @Deprecated + @Target(value=PARAMETER) + @Retention(value=RUNTIME) +public @interface EncodedQuery+
+ Values are converted to strings using String.valueOf(Object). Values are not URL
+ encoded. null values will not include the query parameter in the URL. See
+ @Query for URL-encoding equivalent.
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/EncodedQueryMap.html b/website/1.x/retrofit/retrofit/http/EncodedQueryMap.html new file mode 100644 index 0000000000..d259717e6e --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/EncodedQueryMap.html @@ -0,0 +1,182 @@ + + + + + + +QueryMap with encodeValues = false.@Documented + @Deprecated + @Target(value=PARAMETER) + @Retention(value=RUNTIME) +public @interface EncodedQueryMap+
+ Both keys and values are converted to strings using String.valueOf(Object). Values are
+ not URL encoded. null values will not include the query parameter in the URL. See
+ @QueryMap for URL-encoding equivalent.
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/Field.html b/website/1.x/retrofit/retrofit/http/Field.html new file mode 100644 index 0000000000..87c0d6775d --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/Field.html @@ -0,0 +1,307 @@ + + + + + + +@Documented + @Target(value=PARAMETER) + @Retention(value=RUNTIME) +public @interface Field+
+ Values are converted to strings using String.valueOf(Object) and then form URL encoded.
+ null values are ignored. Passing a List or array will result in a
+ field pair for each non-null item.
+
+ Simple Example: +
+ @FormUrlEncoded
+ @POST("/")
+ void example(@Field("name") String name, @Field("occupation") String occupation);
+ }
+
+ Calling with foo.example("Bob Smith", "President") yields a request body of
+ name=Bob+Smith&occupation=President.
+ + Array Example: +
+ @FormUrlEncoded
+ @POST("/list")
+ void example(@Field("name") String... names);
+
+ Calling with foo.example("Bob Smith", "Jane Doe") yields a request body of
+ name=Bob+Smith&name=Jane+Doe.FormUrlEncoded,
+FieldMap| Modifier and Type | +Required Element and Description | +
|---|---|
String |
+value |
+
| Modifier and Type | +Optional Element and Description | +
|---|---|
boolean |
+encodeName
+Specifies whether
+value() is URL encoded. |
+
boolean |
+encodeValue
+Specifies whether the argument value to the annotated method parameter is URL encoded.
+ |
+
public abstract boolean encodeName+
value() is URL encoded.public abstract boolean encodeValue+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/FieldMap.html b/website/1.x/retrofit/retrofit/http/FieldMap.html new file mode 100644 index 0000000000..cb508f9878 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/FieldMap.html @@ -0,0 +1,264 @@ + + + + + + +@Documented + @Target(value=PARAMETER) + @Retention(value=RUNTIME) +public @interface FieldMap+
+ Field values may be null which will omit them from the request body.
+
+ Simple Example: +
+ @FormUrlEncoded
+ @POST("/things")
+ void things(@FieldMap Map<String, String> fields);
+ }
+
+ Calling with foo.things(ImmutableMap.of("foo", "bar", "kit", "kat") yields a request
+ body of foo=bar&kit=kat.FormUrlEncoded,
+Field| Modifier and Type | +Optional Element and Description | +
|---|---|
boolean |
+encodeNames
+Specifies whether parameter names (keys in the map) are URL encoded.
+ |
+
boolean |
+encodeValues
+Specifies whether parameter values (values in the map) are URL encoded.
+ |
+
public abstract boolean encodeNames+
public abstract boolean encodeValues+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/FormUrlEncoded.html b/website/1.x/retrofit/retrofit/http/FormUrlEncoded.html new file mode 100644 index 0000000000..cfa7dbe2eb --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/FormUrlEncoded.html @@ -0,0 +1,174 @@ + + + + + + +@Documented + @Target(value=METHOD) + @Retention(value=RUNTIME) +public @interface FormUrlEncoded+
@Field.
+
+ Requests made with this annotation will have application/x-www-form-urlencoded MIME
+ type. Field names and values will be UTF-8 encoded before being URI-encoded in accordance to
+ RFC-3986.
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/GET.html b/website/1.x/retrofit/retrofit/http/GET.html new file mode 100644 index 0000000000..3375a86d99 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/GET.html @@ -0,0 +1,218 @@ + + + + + + +@Documented + @Target(value=METHOD) + @Retention(value=RUNTIME) + @RestMethod(value="GET") +public @interface GET+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/HEAD.html b/website/1.x/retrofit/retrofit/http/HEAD.html new file mode 100644 index 0000000000..b6d8c83655 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/HEAD.html @@ -0,0 +1,218 @@ + + + + + + +@Documented + @Target(value=METHOD) + @Retention(value=RUNTIME) + @RestMethod(value="HEAD") +public @interface HEAD+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/Header.html b/website/1.x/retrofit/retrofit/http/Header.html new file mode 100644 index 0000000000..8d0bb024eb --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/Header.html @@ -0,0 +1,232 @@ + + + + + + +@Documented + @Retention(value=RUNTIME) + @Target(value=PARAMETER) +public @interface Header+
+
+ @GET("/")
+ void foo(@Header("Accept-Language") String lang, Callback<Response> cb);
+
+
+ Header parameters may be null which will omit them from the request. Passing a
+ List or array will result in a header for each non-null item.
+
+ Note: Headers do not overwrite each other. All headers with the same name will + be included in the request.
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/Headers.html b/website/1.x/retrofit/retrofit/http/Headers.html new file mode 100644 index 0000000000..09c9c757ee --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/Headers.html @@ -0,0 +1,237 @@ + + + + + + +@Documented + @Target(value=METHOD) + @Retention(value=RUNTIME) +public @interface Headers+
value.
+ +
+ @Headers("Cache-Control: max-age=640000")
+ @GET("/")
+ ...
+
+ @Headers({
+ "X-Foo: Bar",
+ "X-Ping: Pong"
+ })
+ @GET("/")
+ ...
+
+ + Note: Headers do not overwrite each other. All headers with the same name will + be included in the request.
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/Multipart.html b/website/1.x/retrofit/retrofit/http/Multipart.html new file mode 100644 index 0000000000..5edcb6c0e3 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/Multipart.html @@ -0,0 +1,170 @@ + + + + + + +@Documented + @Target(value=METHOD) + @Retention(value=RUNTIME) +public @interface Multipart+
@Part.Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/PATCH.html b/website/1.x/retrofit/retrofit/http/PATCH.html new file mode 100644 index 0000000000..2309c06faa --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/PATCH.html @@ -0,0 +1,219 @@ + + + + + + +@Documented + @Target(value=METHOD) + @Retention(value=RUNTIME) + @RestMethod(value="PATCH", + hasBody=true) +public @interface PATCH+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/POST.html b/website/1.x/retrofit/retrofit/http/POST.html new file mode 100644 index 0000000000..2b8de7792d --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/POST.html @@ -0,0 +1,219 @@ + + + + + + +@Documented + @Target(value=METHOD) + @Retention(value=RUNTIME) + @RestMethod(value="POST", + hasBody=true) +public @interface POST+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/PUT.html b/website/1.x/retrofit/retrofit/http/PUT.html new file mode 100644 index 0000000000..c8665505fb --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/PUT.html @@ -0,0 +1,219 @@ + + + + + + +@Documented + @Target(value=METHOD) + @Retention(value=RUNTIME) + @RestMethod(value="PUT", + hasBody=true) +public @interface PUT+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/Part.html b/website/1.x/retrofit/retrofit/http/Part.html new file mode 100644 index 0000000000..15b420bec6 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/Part.html @@ -0,0 +1,278 @@ + + + + + + +@Documented + @Target(value=PARAMETER) + @Retention(value=RUNTIME) +public @interface Part+
+ The parameter type on which this annotation exists will be processed in one of three ways: +
TypedOutput the headers and
+ body will be used directly.String the value will also be used directly with a text/plain
+ content type.Converter.toBody(Object).
+ Values may be null which will omit them from the request body.
+
+
+ @Multipart
+ @POST("/")
+ void example(@Part("description") String description,
+ @Part("image") TypedFile image,
+ ...
+ );
+
+
+ Part parameters may not be null.
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/PartMap.html b/website/1.x/retrofit/retrofit/http/PartMap.html new file mode 100644 index 0000000000..27ad4b7dcd --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/PartMap.html @@ -0,0 +1,245 @@ + + + + + + +@Documented + @Target(value=PARAMETER) + @Retention(value=RUNTIME) +public @interface PartMap+
+ Values of the map on which this annotation exists will be processed in one of three ways: +
TypedOutput the headers and
+ body will be used directly.String the value will also be used directly with a text/plain
+ content type.Converter.toBody(Object).+
+ @Multipart
+ @POST("/upload")
+ void upload(@Part("file") TypedFile file, @PartMap Map<String, String> params);
+
+ Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/Path.html b/website/1.x/retrofit/retrofit/http/Path.html new file mode 100644 index 0000000000..2340e63d5d --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/Path.html @@ -0,0 +1,277 @@ + + + + + + +@Documented + @Retention(value=RUNTIME) + @Target(value=PARAMETER) +public @interface Path+
String.valueOf(Object) and URL encoded.
+ + Simple example: +
+ @GET("/image/{id}")
+ void example(@Path("id") int id);
+
+ Calling with foo.example(1) yields /image/1.
+
+ Values are URL encoded by default. Disable with encode=false.
+
+ @GET("/user/{name}")
+ void encoded(@Path("name") String name);
+
+ @GET("/user/{name}")
+ void notEncoded(@Path(value="name", encode=false) String name);
+
+ Calling foo.encoded("John+Doe") yields /user/John%2BDoe whereas
+ foo.notEncoded("John+Doe") yields /user/John+Doe.
+
+ Path parameters may not be null.
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/Query.html b/website/1.x/retrofit/retrofit/http/Query.html new file mode 100644 index 0000000000..6507ac2592 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/Query.html @@ -0,0 +1,328 @@ + + + + + + +@Documented + @Target(value=PARAMETER) + @Retention(value=RUNTIME) +public @interface Query+
+ Values are converted to strings using String.valueOf(Object) and then URL encoded.
+ null values are ignored. Passing a List or array will result in a
+ query parameter for each non-null item.
+
+ Simple Example: +
+ @GET("/list")
+ void list(@Query("page") int page);
+
+ Calling with foo.list(1) yields /list?page=1.
+
+ Example with null:
+
+ @GET("/list")
+ void list(@Query("category") String category);
+
+ Calling with foo.list(null) yields /list.
+ + Array Example: +
+ @GET("/list")
+ void list(@Query("category") String... categories);
+
+ Calling with foo.list("bar", "baz") yields
+ /list?category=foo&category=bar.
+
+ Parameter names are not URL encoded. Specify encodeName=true to change
+ this behavior.
+
+ @GET("/search")
+ void list(@Query(value="foo+bar", encodeName=true) String foobar);
+
+ Calling with foo.list("baz") yields /search?foo%2Bbar=foo.
+
+ Parameter values are URL encoded by default. Specify encodeValue=false to
+ change this behavior.
+
+ @GET("/search")
+ void list(@Query(value="foo", encodeValue=false) String foo);
+
+ Calling with foo.list("foo+foo")) yields /search?foo=foo+bar.QueryMap| Modifier and Type | +Required Element and Description | +
|---|---|
String |
+value
+The query parameter name.
+ |
+
| Modifier and Type | +Optional Element and Description | +
|---|---|
boolean |
+encodeName
+Specifies whether
+value() is URL encoded. |
+
boolean |
+encodeValue
+Specifies whether the argument value to the annotated method parameter is URL encoded.
+ |
+
public abstract String value+
public abstract boolean encodeName+
value() is URL encoded.public abstract boolean encodeValue+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/QueryMap.html b/website/1.x/retrofit/retrofit/http/QueryMap.html new file mode 100644 index 0000000000..d7b4cf100d --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/QueryMap.html @@ -0,0 +1,281 @@ + + + + + + +@Documented + @Target(value=PARAMETER) + @Retention(value=RUNTIME) +public @interface QueryMap+
+ Both keys and values are converted to strings using String.valueOf(Object). Values are
+ URL encoded and null will not include the query parameter in the URL. null keys
+ are not allowed.
+
+ Simple Example: +
+ @GET("/search")
+ void list(@QueryMap Map<String, String> filters);
+
+ Calling with foo.list(ImmutableMap.of("foo", "bar", "kit", "kat")) yields
+ /search?foo=bar&kit=kat.
+
+ Map keys representing the parameter names are not URL encoded. Specify
+ encodeNames=true to change this behavior.
+
+ @GET("/search")
+ void list(@QueryMap(encodeNames=true) Map<String, String> filters);
+
+ Calling with foo.list(ImmutableMap.of("foo+bar", "foo+bar")) yields
+ /search?foo%2Bbar=foo.
+
+ Map values representing parameter values are URL encoded by default. Specify
+ encodeValues=false to change this behavior.
+
+ @GET("/search")
+ void list(@QueryMap(encodeValues=false) Map<String, String> filters);
+
+ Calling with foo.list(ImmutableMap.of("foo", "foo+foo")) yields
+ /search?foo=foo%2Bbar.Query| Modifier and Type | +Optional Element and Description | +
|---|---|
boolean |
+encodeNames
+Specifies whether parameter names (keys in the map) are URL encoded.
+ |
+
boolean |
+encodeValues
+Specifies whether parameter values (values in the map) are URL encoded.
+ |
+
public abstract boolean encodeNames+
public abstract boolean encodeValues+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/RestMethod.html b/website/1.x/retrofit/retrofit/http/RestMethod.html new file mode 100644 index 0000000000..72f94db187 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/RestMethod.html @@ -0,0 +1,252 @@ + + + + + + +@Documented + @Target(value=ANNOTATION_TYPE) + @Retention(value=RUNTIME) +public @interface RestMethod+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/Streaming.html b/website/1.x/retrofit/retrofit/http/Streaming.html new file mode 100644 index 0000000000..1adddf7852 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/Streaming.html @@ -0,0 +1,170 @@ + + + + + + +@Documented + @Target(value=METHOD) + @Retention(value=RUNTIME) +public @interface Streaming+ +
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/Body.html b/website/1.x/retrofit/retrofit/http/class-use/Body.html new file mode 100644 index 0000000000..289dfb6d15 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/Body.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/DELETE.html b/website/1.x/retrofit/retrofit/http/class-use/DELETE.html new file mode 100644 index 0000000000..c43bf21ab5 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/DELETE.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/EncodedPath.html b/website/1.x/retrofit/retrofit/http/class-use/EncodedPath.html new file mode 100644 index 0000000000..480be2cfab --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/EncodedPath.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/EncodedQuery.html b/website/1.x/retrofit/retrofit/http/class-use/EncodedQuery.html new file mode 100644 index 0000000000..15901f22fd --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/EncodedQuery.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/EncodedQueryMap.html b/website/1.x/retrofit/retrofit/http/class-use/EncodedQueryMap.html new file mode 100644 index 0000000000..279bf4d58c --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/EncodedQueryMap.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/Field.html b/website/1.x/retrofit/retrofit/http/class-use/Field.html new file mode 100644 index 0000000000..e75fb845e2 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/Field.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/FieldMap.html b/website/1.x/retrofit/retrofit/http/class-use/FieldMap.html new file mode 100644 index 0000000000..c6aca62a01 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/FieldMap.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/FormUrlEncoded.html b/website/1.x/retrofit/retrofit/http/class-use/FormUrlEncoded.html new file mode 100644 index 0000000000..911e77f585 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/FormUrlEncoded.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/GET.html b/website/1.x/retrofit/retrofit/http/class-use/GET.html new file mode 100644 index 0000000000..92b9197957 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/GET.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/HEAD.html b/website/1.x/retrofit/retrofit/http/class-use/HEAD.html new file mode 100644 index 0000000000..2c6f90f4e3 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/HEAD.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/Header.html b/website/1.x/retrofit/retrofit/http/class-use/Header.html new file mode 100644 index 0000000000..5c89a61b76 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/Header.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/Headers.html b/website/1.x/retrofit/retrofit/http/class-use/Headers.html new file mode 100644 index 0000000000..998ab3b523 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/Headers.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/Multipart.html b/website/1.x/retrofit/retrofit/http/class-use/Multipart.html new file mode 100644 index 0000000000..65bd3a5846 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/Multipart.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/PATCH.html b/website/1.x/retrofit/retrofit/http/class-use/PATCH.html new file mode 100644 index 0000000000..8db4260a6c --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/PATCH.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/POST.html b/website/1.x/retrofit/retrofit/http/class-use/POST.html new file mode 100644 index 0000000000..8fd578e4a3 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/POST.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/PUT.html b/website/1.x/retrofit/retrofit/http/class-use/PUT.html new file mode 100644 index 0000000000..ffe5ddcbe2 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/PUT.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/Part.html b/website/1.x/retrofit/retrofit/http/class-use/Part.html new file mode 100644 index 0000000000..b294f4d9f2 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/Part.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/PartMap.html b/website/1.x/retrofit/retrofit/http/class-use/PartMap.html new file mode 100644 index 0000000000..32286fb5a6 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/PartMap.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/Path.html b/website/1.x/retrofit/retrofit/http/class-use/Path.html new file mode 100644 index 0000000000..7a1868588b --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/Path.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/Query.html b/website/1.x/retrofit/retrofit/http/class-use/Query.html new file mode 100644 index 0000000000..b158afa4c8 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/Query.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/QueryMap.html b/website/1.x/retrofit/retrofit/http/class-use/QueryMap.html new file mode 100644 index 0000000000..6b44f66910 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/QueryMap.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/RestMethod.html b/website/1.x/retrofit/retrofit/http/class-use/RestMethod.html new file mode 100644 index 0000000000..fdb4865d64 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/RestMethod.html @@ -0,0 +1,200 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit.http | +
+ Annotations for interface methods to control the HTTP request behavior.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
interface |
+DELETE
+Make a DELETE request to a REST path relative to base URL.
+ |
+
interface |
+GET
+Make a GET request to a REST path relative to base URL.
+ |
+
interface |
+HEAD
+Make a HEAD request to a REST path relative to base URL.
+ |
+
interface |
+PATCH
+Make a PATCH request to a REST path relative to base URL.
+ |
+
interface |
+POST
+Make a POST request to a REST path relative to base URL.
+ |
+
interface |
+PUT
+Make a PUT request to a REST path relative to base URL.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/class-use/Streaming.html b/website/1.x/retrofit/retrofit/http/class-use/Streaming.html new file mode 100644 index 0000000000..127ad6b389 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/class-use/Streaming.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/package-frame.html b/website/1.x/retrofit/retrofit/http/package-frame.html new file mode 100644 index 0000000000..c8eaf4a29d --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/package-frame.html @@ -0,0 +1,43 @@ + + + + + + +See: Description
+| Annotation Type | +Description | +
|---|---|
| Body | +
+ Use this annotation on a service method param when you want to directly control the request body
+ of a POST/PUT request (instead of sending in as request parameters or form-style request
+ body).
+ |
+
| DELETE | +
+ Make a DELETE request to a REST path relative to base URL.
+ |
+
| EncodedPath | +Deprecated
+ Use
+Path with encode = false. |
+
| EncodedQuery | +Deprecated
+ Use
+Query with encodeValue = false. |
+
| EncodedQueryMap | +Deprecated
+ Use
+QueryMap with encodeValues = false. |
+
| Field | +
+ Named pair for a form-encoded request.
+ |
+
| FieldMap | +
+ Named key/value pairs for a form-encoded request.
+ |
+
| FormUrlEncoded | +
+ Denotes that the request body will use form URL encoding.
+ |
+
| GET | +
+ Make a GET request to a REST path relative to base URL.
+ |
+
| HEAD | +
+ Make a HEAD request to a REST path relative to base URL.
+ |
+
| Header | +
+ Replaces the header with the the value of its target.
+ |
+
| Headers | +
+ Adds headers literally supplied in the
+value. |
+
| Multipart | +
+ Denotes that the request body is multi-part.
+ |
+
| Part | +
+ Denotes a single part of a multi-part request.
+ |
+
| PartMap | +
+ Denotes name and value parts of a multi-part request
+ |
+
| PATCH | +
+ Make a PATCH request to a REST path relative to base URL.
+ |
+
| Path | +
+ Named replacement in the URL path.
+ |
+
| POST | +
+ Make a POST request to a REST path relative to base URL.
+ |
+
| PUT | +
+ Make a PUT request to a REST path relative to base URL.
+ |
+
| Query | +
+ Query parameter appended to the URL.
+ |
+
| QueryMap | +
+ Query parameter keys and values appended to the URL.
+ |
+
| RestMethod | ++ |
| Streaming | +
+ Treat the response body on methods returning
+Response as is,
+ i.e. |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/package-tree.html b/website/1.x/retrofit/retrofit/http/package-tree.html new file mode 100644 index 0000000000..281b17d709 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/http/package-use.html b/website/1.x/retrofit/retrofit/http/package-use.html new file mode 100644 index 0000000000..4d299aa641 --- /dev/null +++ b/website/1.x/retrofit/retrofit/http/package-use.html @@ -0,0 +1,161 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit.http | +
+ Annotations for interface methods to control the HTTP request behavior.
+ |
+
| Class and Description | +
|---|
| RestMethod | +
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/FormUrlEncodedTypedOutput.html b/website/1.x/retrofit/retrofit/mime/FormUrlEncodedTypedOutput.html new file mode 100644 index 0000000000..8c7dfa5ab7 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/FormUrlEncodedTypedOutput.html @@ -0,0 +1,388 @@ + + + + + + +public final class FormUrlEncodedTypedOutput +extends Object +implements TypedOutput+
| Constructor and Description | +
|---|
FormUrlEncodedTypedOutput() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addField(String name,
+ boolean encodeName,
+ String value,
+ boolean encodeValue) |
+
void |
+addField(String name,
+ String value) |
+
String |
+fileName()
+Original filename.
+ |
+
long |
+length()
+Length in bytes or -1 if unknown.
+ |
+
String |
+mimeType()
+Returns the mime type.
+ |
+
void |
+writeTo(OutputStream out)
+Writes these bytes to the given output stream.
+ |
+
public FormUrlEncodedTypedOutput()+
public void addField(String name, + boolean encodeName, + String value, + boolean encodeValue)+
public String fileName()+
TypedOutputfileName in interface TypedOutputpublic String mimeType()+
TypedOutputmimeType in interface TypedOutputpublic long length()+
TypedOutputlength in interface TypedOutputpublic void writeTo(OutputStream out) + throws IOException+
TypedOutputwriteTo in interface TypedOutputIOExceptionCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/MimeUtil.html b/website/1.x/retrofit/retrofit/mime/MimeUtil.html new file mode 100644 index 0000000000..f61c413821 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/MimeUtil.html @@ -0,0 +1,264 @@ + + + + + + +public final class MimeUtil +extends Object+
| Modifier and Type | +Method and Description | +
|---|---|
static String |
+parseCharset(String mimeType)
+Deprecated.
+
+
+ |
+
static String |
+parseCharset(String mimeType,
+ String defaultCharset)
+Parse the MIME type from a
+Content-Type header value. |
+
@Deprecated +public static String parseCharset(String mimeType)+
parseCharset(String, String).Content-Type header value or default to "UTF-8".Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/MultipartTypedOutput.html b/website/1.x/retrofit/retrofit/mime/MultipartTypedOutput.html new file mode 100644 index 0000000000..493069b332 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/MultipartTypedOutput.html @@ -0,0 +1,439 @@ + + + + + + +public final class MultipartTypedOutput +extends Object +implements TypedOutput+
| Modifier and Type | +Field and Description | +
|---|---|
static String |
+DEFAULT_TRANSFER_ENCODING |
+
| Constructor and Description | +
|---|
MultipartTypedOutput() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+addPart(String name,
+ String transferEncoding,
+ TypedOutput body) |
+
void |
+addPart(String name,
+ TypedOutput body) |
+
String |
+fileName()
+Original filename.
+ |
+
int |
+getPartCount() |
+
long |
+length()
+Length in bytes or -1 if unknown.
+ |
+
String |
+mimeType()
+Returns the mime type.
+ |
+
void |
+writeTo(OutputStream out)
+Writes these bytes to the given output stream.
+ |
+
public static final String DEFAULT_TRANSFER_ENCODING+
public void addPart(String name, + TypedOutput body)+
public void addPart(String name, + String transferEncoding, + TypedOutput body)+
public int getPartCount()+
public String fileName()+
TypedOutputfileName in interface TypedOutputpublic String mimeType()+
TypedOutputmimeType in interface TypedOutputpublic long length()+
TypedOutputlength in interface TypedOutputpublic void writeTo(OutputStream out) + throws IOException+
TypedOutputwriteTo in interface TypedOutputIOExceptionCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/TypedByteArray.html b/website/1.x/retrofit/retrofit/mime/TypedByteArray.html new file mode 100644 index 0000000000..45a39a9361 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/TypedByteArray.html @@ -0,0 +1,465 @@ + + + + + + +public class TypedByteArray +extends Object +implements TypedInput, TypedOutput+
| Constructor and Description | +
|---|
TypedByteArray(String mimeType,
+ byte[] bytes)
+Constructs a new typed byte array.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object o) |
+
String |
+fileName()
+Original filename.
+ |
+
byte[] |
+getBytes() |
+
int |
+hashCode() |
+
InputStream |
+in()
+Read bytes as stream.
+ |
+
long |
+length()
+Length in bytes.
+ |
+
String |
+mimeType()
+Returns the mime type.
+ |
+
String |
+toString() |
+
void |
+writeTo(OutputStream out)
+Writes these bytes to the given output stream.
+ |
+
public TypedByteArray(String mimeType, + byte[] bytes)+
application/unknown if absent.NullPointerException - if bytes are nullpublic byte[] getBytes()+
public String fileName()+
TypedOutputfileName in interface TypedOutputpublic String mimeType()+
TypedInputmimeType in interface TypedInputmimeType in interface TypedOutputpublic long length()+
TypedInput-1 if length is unknown.length in interface TypedInputlength in interface TypedOutputpublic void writeTo(OutputStream out) + throws IOException+
TypedOutputwriteTo in interface TypedOutputIOExceptionpublic InputStream in() + throws IOException+
TypedInputin in interface TypedInputIOExceptionCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/TypedFile.html b/website/1.x/retrofit/retrofit/mime/TypedFile.html new file mode 100644 index 0000000000..124f4e532a --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/TypedFile.html @@ -0,0 +1,487 @@ + + + + + + +public class TypedFile +extends Object +implements TypedInput, TypedOutput+
| Constructor and Description | +
|---|
TypedFile(String mimeType,
+ File file)
+Constructs a new typed file.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
boolean |
+equals(Object o) |
+
File |
+file()
+Returns the file.
+ |
+
String |
+fileName()
+Original filename.
+ |
+
int |
+hashCode() |
+
InputStream |
+in()
+Read bytes as stream.
+ |
+
long |
+length()
+Length in bytes.
+ |
+
String |
+mimeType()
+Returns the mime type.
+ |
+
void |
+moveTo(TypedFile destination)
+Atomically moves the contents of this file to a new location.
+ |
+
String |
+toString() |
+
void |
+writeTo(OutputStream out)
+Writes these bytes to the given output stream.
+ |
+
public TypedFile(String mimeType, + File file)+
NullPointerException - if file or mimeType is nullpublic File file()+
public String mimeType()+
TypedInputmimeType in interface TypedInputmimeType in interface TypedOutputpublic long length()+
TypedInput-1 if length is unknown.length in interface TypedInputlength in interface TypedOutputpublic String fileName()+
TypedOutputfileName in interface TypedOutputpublic InputStream in() + throws IOException+
TypedInputin in interface TypedInputIOExceptionpublic void writeTo(OutputStream out) + throws IOException+
TypedOutputwriteTo in interface TypedOutputIOExceptionpublic void moveTo(TypedFile destination) + throws IOException+
destination - fileIOException - if the move failsCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/TypedInput.html b/website/1.x/retrofit/retrofit/mime/TypedInput.html new file mode 100644 index 0000000000..aae1860191 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/TypedInput.html @@ -0,0 +1,273 @@ + + + + + + +public interface TypedInput
+| Modifier and Type | +Method and Description | +
|---|---|
InputStream |
+in()
+Read bytes as stream.
+ |
+
long |
+length()
+Length in bytes.
+ |
+
String |
+mimeType()
+Returns the mime type.
+ |
+
String mimeType()+
long length()+
-1 if length is unknown.InputStream in() + throws IOException+
IOExceptionCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/TypedOutput.html b/website/1.x/retrofit/retrofit/mime/TypedOutput.html new file mode 100644 index 0000000000..ad59f1687d --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/TypedOutput.html @@ -0,0 +1,290 @@ + + + + + + +public interface TypedOutput
+| Modifier and Type | +Method and Description | +
|---|---|
String |
+fileName()
+Original filename.
+ |
+
long |
+length()
+Length in bytes or -1 if unknown.
+ |
+
String |
+mimeType()
+Returns the mime type.
+ |
+
void |
+writeTo(OutputStream out)
+Writes these bytes to the given output stream.
+ |
+
String fileName()+
String mimeType()+
long length()+
void writeTo(OutputStream out) + throws IOException+
IOExceptionCopyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/TypedString.html b/website/1.x/retrofit/retrofit/mime/TypedString.html new file mode 100644 index 0000000000..6b6a98841c --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/TypedString.html @@ -0,0 +1,293 @@ + + + + + + +public class TypedString +extends TypedByteArray+
| Constructor and Description | +
|---|
TypedString(String string) |
+
| Modifier and Type | +Method and Description | +
|---|---|
String |
+toString() |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/class-use/FormUrlEncodedTypedOutput.html b/website/1.x/retrofit/retrofit/mime/class-use/FormUrlEncodedTypedOutput.html new file mode 100644 index 0000000000..9b39559dc8 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/class-use/FormUrlEncodedTypedOutput.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/class-use/MimeUtil.html b/website/1.x/retrofit/retrofit/mime/class-use/MimeUtil.html new file mode 100644 index 0000000000..8877aa5b16 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/class-use/MimeUtil.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/class-use/MultipartTypedOutput.html b/website/1.x/retrofit/retrofit/mime/class-use/MultipartTypedOutput.html new file mode 100644 index 0000000000..da8d31f0e4 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/class-use/MultipartTypedOutput.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/class-use/TypedByteArray.html b/website/1.x/retrofit/retrofit/mime/class-use/TypedByteArray.html new file mode 100644 index 0000000000..f31f200411 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/class-use/TypedByteArray.html @@ -0,0 +1,166 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit.mime | ++ |
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TypedString |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/class-use/TypedFile.html b/website/1.x/retrofit/retrofit/mime/class-use/TypedFile.html new file mode 100644 index 0000000000..a966fb79b0 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/class-use/TypedFile.html @@ -0,0 +1,168 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit.mime | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
void |
+TypedFile.moveTo(TypedFile destination)
+Atomically moves the contents of this file to a new location.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/class-use/TypedInput.html b/website/1.x/retrofit/retrofit/mime/class-use/TypedInput.html new file mode 100644 index 0000000000..24d9db75b6 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/class-use/TypedInput.html @@ -0,0 +1,247 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit.client | ++ |
| retrofit.converter | ++ |
| retrofit.mime | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
TypedInput |
+Response.getBody()
+Response body.
+ |
+
| Constructor and Description | +
|---|
Response(String url,
+ int status,
+ String reason,
+ List<Header> headers,
+ TypedInput body) |
+
| Modifier and Type | +Method and Description | +
|---|---|
Object |
+GsonConverter.fromBody(TypedInput body,
+ Type type) |
+
Object |
+Converter.fromBody(TypedInput body,
+ Type type)
+Convert an HTTP response body to a concrete object of the specified type.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+TypedByteArray
+Byte array and its mime type.
+ |
+
class |
+TypedFile
+File and its mime type.
+ |
+
class |
+TypedString |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/class-use/TypedOutput.html b/website/1.x/retrofit/retrofit/mime/class-use/TypedOutput.html new file mode 100644 index 0000000000..6a5f8d9ec6 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/class-use/TypedOutput.html @@ -0,0 +1,272 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit.client | ++ |
| retrofit.converter | ++ |
| retrofit.mime | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
TypedOutput |
+Request.getBody()
+Returns the request body or
+null. |
+
| Constructor and Description | +
|---|
Request(String method,
+ String url,
+ List<Header> headers,
+ TypedOutput body) |
+
| Modifier and Type | +Method and Description | +
|---|---|
TypedOutput |
+GsonConverter.toBody(Object object) |
+
TypedOutput |
+Converter.toBody(Object object)
+Convert an object to an appropriate representation for HTTP transport.
+ |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+FormUrlEncodedTypedOutput |
+
class |
+MultipartTypedOutput |
+
class |
+TypedByteArray
+Byte array and its mime type.
+ |
+
class |
+TypedFile
+File and its mime type.
+ |
+
class |
+TypedString |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+MultipartTypedOutput.addPart(String name,
+ String transferEncoding,
+ TypedOutput body) |
+
void |
+MultipartTypedOutput.addPart(String name,
+ TypedOutput body) |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/class-use/TypedString.html b/website/1.x/retrofit/retrofit/mime/class-use/TypedString.html new file mode 100644 index 0000000000..291bb63b67 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/class-use/TypedString.html @@ -0,0 +1,126 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/package-frame.html b/website/1.x/retrofit/retrofit/mime/package-frame.html new file mode 100644 index 0000000000..b21d4b3f46 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/package-frame.html @@ -0,0 +1,31 @@ + + + + + + +| Interface | +Description | +
|---|---|
| TypedInput | +
+ Binary data with an associated mime type.
+ |
+
| TypedOutput | +
+ Binary data with an associated mime type.
+ |
+
| Class | +Description | +
|---|---|
| FormUrlEncodedTypedOutput | ++ |
| MimeUtil | ++ |
| MultipartTypedOutput | ++ |
| TypedByteArray | +
+ Byte array and its mime type.
+ |
+
| TypedFile | +
+ File and its mime type.
+ |
+
| TypedString | ++ |
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/package-tree.html b/website/1.x/retrofit/retrofit/mime/package-tree.html new file mode 100644 index 0000000000..1c51c063c7 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/package-tree.html @@ -0,0 +1,152 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/mime/package-use.html b/website/1.x/retrofit/retrofit/mime/package-use.html new file mode 100644 index 0000000000..9e0de9a858 --- /dev/null +++ b/website/1.x/retrofit/retrofit/mime/package-use.html @@ -0,0 +1,228 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit.client | ++ |
| retrofit.converter | ++ |
| retrofit.mime | ++ |
| Class and Description | +
|---|
| TypedInput
+ Binary data with an associated mime type.
+ |
+
| TypedOutput
+ Binary data with an associated mime type.
+ |
+
| Class and Description | +
|---|
| TypedInput
+ Binary data with an associated mime type.
+ |
+
| TypedOutput
+ Binary data with an associated mime type.
+ |
+
| Class and Description | +
|---|
| TypedByteArray
+ Byte array and its mime type.
+ |
+
| TypedFile
+ File and its mime type.
+ |
+
| TypedInput
+ Binary data with an associated mime type.
+ |
+
| TypedOutput
+ Binary data with an associated mime type.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/package-frame.html b/website/1.x/retrofit/retrofit/package-frame.html new file mode 100644 index 0000000000..a13eecd337 --- /dev/null +++ b/website/1.x/retrofit/retrofit/package-frame.html @@ -0,0 +1,44 @@ + + + + + + +| Interface | +Description | +
|---|---|
| Callback<T> | +
+ Communicates responses from a server or offline requests.
+ |
+
| Endpoint | +
+ Represents an API endpoint URL and associated name.
+ |
+
| ErrorHandler | +
+ A hook allowing clients to customize
+response exceptions. |
+
| Profiler<T> | +
+ A hook allowing clients to log HTTP method times and response status codes.
+ |
+
| RequestInterceptor | +
+ Intercept every request before it is executed in order to add additional data.
+ |
+
| RequestInterceptor.RequestFacade | ++ |
| RestAdapter.Log | +
+ Simple logging abstraction for debug messages.
+ |
+
| Class | +Description | +
|---|---|
| Endpoints | +
+ Static factory methods for creating
+Endpoint instances. |
+
| Profiler.RequestInformation | +
+ Information about the HTTP request.
+ |
+
| ResponseCallback | +
+ An extension of
+Callback which returns only Response object
+ in Callback.success(Object, retrofit.client.Response) method. |
+
| RestAdapter | +
+ Adapts a Java interface to a REST API.
+ |
+
| RestAdapter.Builder | +
+ Build a new
+RestAdapter. |
+
| Enum | +Description | +
|---|---|
| RestAdapter.LogLevel | +
+ Controls the level of logging.
+ |
+
| RetrofitError.Kind | +
+ Identifies the event kind which triggered a
+RetrofitError. |
+
| Exception | +Description | +
|---|---|
| RetrofitError | ++ |
+ public interface GitHubService {
+ @GET("/users/{user}/repos")
+ List<Repo> listRepos(@Path("user") String user);
+ }
+ Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/package-tree.html b/website/1.x/retrofit/retrofit/package-tree.html new file mode 100644 index 0000000000..7afa7ec98a --- /dev/null +++ b/website/1.x/retrofit/retrofit/package-tree.html @@ -0,0 +1,179 @@ + + + + + + +Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/retrofit/package-use.html b/website/1.x/retrofit/retrofit/package-use.html new file mode 100644 index 0000000000..cb498670ec --- /dev/null +++ b/website/1.x/retrofit/retrofit/package-use.html @@ -0,0 +1,240 @@ + + + + + + +| Package | +Description | +
|---|---|
| retrofit | +
+ Retrofit turns your REST API into a Java interface.
+ |
+
| retrofit.android | ++ |
| Class and Description | +
|---|
| Callback
+ Communicates responses from a server or offline requests.
+ |
+
| Endpoint
+ Represents an API endpoint URL and associated name.
+ |
+
| ErrorHandler
+ A hook allowing clients to customize
+response exceptions. |
+
| Profiler
+ A hook allowing clients to log HTTP method times and response status codes.
+ |
+
| Profiler.RequestInformation
+ Information about the HTTP request.
+ |
+
| RequestInterceptor
+ Intercept every request before it is executed in order to add additional data.
+ |
+
| RequestInterceptor.RequestFacade | +
| RestAdapter
+ Adapts a Java interface to a REST API.
+ |
+
| RestAdapter.Builder
+ Build a new
+RestAdapter. |
+
| RestAdapter.Log
+ Simple logging abstraction for debug messages.
+ |
+
| RestAdapter.LogLevel
+ Controls the level of logging.
+ |
+
| RetrofitError | +
| RetrofitError.Kind
+ Identifies the event kind which triggered a
+RetrofitError. |
+
| Class and Description | +
|---|
| RestAdapter.Log
+ Simple logging abstraction for debug messages.
+ |
+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/script.js b/website/1.x/retrofit/script.js new file mode 100644 index 0000000000..b346356931 --- /dev/null +++ b/website/1.x/retrofit/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/website/1.x/retrofit/serialized-form.html b/website/1.x/retrofit/serialized-form.html new file mode 100644 index 0000000000..5d53e54742 --- /dev/null +++ b/website/1.x/retrofit/serialized-form.html @@ -0,0 +1,176 @@ + + + + + + +String url+
Response response+
Converter converter+
Type successType+
RetrofitError.Kind kind+
Copyright © 2015 Square, Inc.. All Rights Reserved.
+ + diff --git a/website/1.x/retrofit/stylesheet.css b/website/1.x/retrofit/stylesheet.css new file mode 100644 index 0000000000..cebb4fd8d5 --- /dev/null +++ b/website/1.x/retrofit/stylesheet.css @@ -0,0 +1,574 @@ +/* Javadoc style sheet */ +/* +Overall document style +*/ + +@import url('resources/fonts/dejavu.css'); + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; + width:100%; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} diff --git a/website/1.x/retrofit/version.txt b/website/1.x/retrofit/version.txt new file mode 100644 index 0000000000..abb1658232 --- /dev/null +++ b/website/1.x/retrofit/version.txt @@ -0,0 +1 @@ +1.9.0 \ No newline at end of file diff --git a/website/1.x/sample-github-client/META-INF/MANIFEST.MF b/website/1.x/sample-github-client/META-INF/MANIFEST.MF new file mode 100644 index 0000000000..6e4b325163 --- /dev/null +++ b/website/1.x/sample-github-client/META-INF/MANIFEST.MF @@ -0,0 +1,6 @@ +Manifest-Version: 1.0 +Archiver-Version: Plexus Archiver +Created-By: Apache Maven +Built-By: jw +Build-Jdk: 1.6.0_45 + diff --git a/website/1.x/sample-github-client/allclasses-frame.html b/website/1.x/sample-github-client/allclasses-frame.html new file mode 100644 index 0000000000..82da2d6c3f --- /dev/null +++ b/website/1.x/sample-github-client/allclasses-frame.html @@ -0,0 +1,32 @@ + + + + + + +| GitHubClient
+ + |
+
| GitHubClient
+ + |
+
+
+
|
++ + | +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
| + SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+java.lang.Object ++
public class GitHubClient
+
| +Constructor Summary | +|
|---|---|
GitHubClient()
+
++ |
+|
| +Method Summary | +|
|---|---|
+static void |
+main(String... args)
+
++ |
+
| Methods inherited from class java.lang.Object | +
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
+
| +Constructor Detail | +
|---|
+public GitHubClient()+
| +Method Detail | +
|---|
+public static void main(String... args)+
+
+
|
++ + | +||||||||
| + PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
| + SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
|
+Classes
+
+ +GitHubClient |
+
+
+
|
++ + | +||||||||
| + PREV PACKAGE + NEXT PACKAGE | ++ FRAMES + NO FRAMES + + + + + | +||||||||
| +Class Summary | +|
|---|---|
| GitHubClient | ++ |
+
+
+
|
++ + | +||||||||
| + PREV PACKAGE + NEXT PACKAGE | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ +++Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:
+
+- Interfaces (italic)
- Classes
- Enums
- Exceptions
- Errors
- Annotation Types
+ ++ ++Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description +
+
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary +
+
- Field Detail
- Constructor Detail
- Method Detail
+ ++ ++Each annotation type has its own separate page with the following sections:
+
+- Annotation Type declaration
- Annotation Type description
- Required Element Summary
- Optional Element Summary
- Element Detail
+ +++Each enum has its own separate page with the following sections:
+
+- Enum declaration
- Enum description
- Enum Constant Summary
- Enum Constant Detail
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with+java.lang.Object. The interfaces do not inherit fromjava.lang.Object.+
+- When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
- When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.+
+
+
+
+
+This help file applies to API documentation generated using the standard doclet.
+
+
+
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+
+
|
++ + | +||||||||
| + PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +||||||||