Skip to content

Commit ec2c9a3

Browse files
dmaccormackdmaccormack
committed
Commit initial revision
JSON->URL uses Apache Maven (as its build system) and this repository stores a multimodule POM at the root and each module as a subdirectory inside the module directory.
1 parent 7da5521 commit ec2c9a3

Some content is hidden

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

56 files changed

+6191
-0
lines changed

‎.gitattributes‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# default to binary
2+
* binary
3+
4+
# Java source
5+
*.java text diff=java eol=lf
6+
7+
# HTML, CSS, etc
8+
*.css text diff=css eol=lf
9+
*.htm text diff=html eol=lf
10+
*.html text diff=html eol=lf
11+
*.js text eol=lf
12+
13+
# General text
14+
*.properties text eol=lf
15+
*.xml text eol=lf
16+
*.md text eol=lf

‎.gitignore‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
#
2+
# Maven
3+
#
4+
**/target/
5+
**/pom.xml.tag
6+
**/pom.xml.releaseBackup
7+
**/pom.xml.versionsBackup
8+
**/pom.xml.next
9+
**/release.properties
10+
**/dependency-reduced-pom.xml
11+
**/buildNumber.properties
12+
**/.mvn/timing.properties
13+
# https://github.com/takari/maven-wrapper#usage-without-binary-jar
14+
**/.mvn/wrapper/maven-wrapper.jar
15+
16+
#
17+
# Eclipse
18+
#
19+
**/.project
20+
**/.classpath
21+
**/.checkstyle
22+
**/.settings/
23+

‎NOTICE‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
jsonurl
2+
Copyright 2019 David MacCormack

‎README.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# About JSON->URL
2+
RFC8259 describes the JSON data model and interchange format, which is widely
3+
used in application-level protocols including RESTful APIs. It is common for
4+
applications to request resources via the HTTP POST method, with JSON entities,
5+
however, POST is suboptimal for requests which do not modify a resource's
6+
state. JSON->URL defines a text format for the JSON data model suitable for use
7+
within a URL/URI (as described by RFC3986).

‎config/README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# About
2+
This directory holds toolchain related configurations (checkstyle, etc).
3+

‎config/checkstyle.xml‎

Lines changed: 231 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,231 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Check Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
3+
4+
<!--
5+
This configuration file was written by the eclipse-cs plugin configuration editor
6+
-->
7+
<!--
8+
Checkstyle-Configuration: jsonurl checkstyle
9+
Description:
10+
Checkstyle configuration that checks the Google coding conventions from Google Java Style that can be found at https://google.github.io/styleguide/javaguide.html.
11+
-->
12+
<module name="Checker">
13+
<property name="severity" value="error"/>
14+
<property name="charset" value="UTF-8"/>
15+
<property name="fileExtensions" value="java, properties, xml"/>
16+
<module name="TreeWalker">
17+
<module name="OuterTypeFilename"/>
18+
<module name="IllegalTokenText">
19+
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
20+
<property name="format" value="\\u00(09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
21+
<property name="message" value="Consider using special escape sequence instead of octal value or Unicode escaped value."/>
22+
</module>
23+
<module name="AvoidEscapedUnicodeCharacters">
24+
<property name="allowEscapesForControlCharacters" value="true"/>
25+
<property name="allowByTailComment" value="true"/>
26+
<property name="allowNonPrintableEscapes" value="true"/>
27+
</module>
28+
<module name="AvoidStarImport"/>
29+
<module name="OneTopLevelClass"/>
30+
<module name="NoLineWrap">
31+
<property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
32+
</module>
33+
<module name="EmptyBlock">
34+
<property name="option" value="TEXT"/>
35+
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
36+
</module>
37+
<module name="NeedBraces">
38+
<property name="tokens" value="LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE"/>
39+
</module>
40+
<module name="LeftCurly">
41+
<property name="tokens" value="ANNOTATION_DEF, CLASS_DEF, CTOR_DEF, ENUM_CONSTANT_DEF, ENUM_DEF, INTERFACE_DEF, LAMBDA, LITERAL_CASE, LITERAL_CATCH, LITERAL_DEFAULT, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, METHOD_DEF, OBJBLOCK, STATIC_INIT"/>
42+
</module>
43+
<module name="RightCurly">
44+
<property name="id" value="RightCurlySame"/>
45+
<property name="tokens" value="LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_DO"/>
46+
</module>
47+
<module name="RightCurly">
48+
<property name="id" value="RightCurlyAlone"/>
49+
<property name="option" value="alone"/>
50+
<property name="tokens" value="CLASS_DEF,METHOD_DEF,CTOR_DEF,LITERAL_FOR,LITERAL_WHILE,STATIC_INIT,INSTANCE_INIT,ANNOTATION_DEF,ENUM_DEF"/>
51+
</module>
52+
<module name="WhitespaceAround">
53+
<property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, DO_WHILE, EQUAL, GE, GT, LAMBDA, LAND, LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS, MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION, RCURLY, SL, SLIST, SL_ASSIGN, SR, SR_ASSIGN, STAR, STAR_ASSIGN, LITERAL_ASSERT, TYPE_EXTENSION_AND"/>
54+
<property name="allowEmptyConstructors" value="true"/>
55+
<property name="allowEmptyMethods" value="true"/>
56+
<property name="allowEmptyTypes" value="true"/>
57+
<property name="allowEmptyLoops" value="true"/>
58+
<property name="allowEmptyLambdas" value="true"/>
59+
<message key="ws.notPreceded" value="WhitespaceAround: ''{0}'' is not preceded with whitespace."/>
60+
<message key="ws.notFollowed" value="WhitespaceAround: ''{0}'' is not followed by whitespace. Empty blocks may only be represented as '{}' when not part of a multi-block statement (4.1.3)"/>
61+
</module>
62+
<module name="OneStatementPerLine"/>
63+
<module name="MultipleVariableDeclarations"/>
64+
<module name="ArrayTypeStyle"/>
65+
<module name="FallThrough"/>
66+
<module name="UpperEll"/>
67+
<module name="ModifierOrder"/>
68+
<module name="EmptyLineSeparator">
69+
<property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT, CLASS_DEF, INTERFACE_DEF, ENUM_DEF, STATIC_INIT, INSTANCE_INIT, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
70+
<property name="allowNoEmptyLineBetweenFields" value="true"/>
71+
</module>
72+
<module name="SeparatorWrap">
73+
<property name="id" value="SeparatorWrapDot"/>
74+
<property name="option" value="nl"/>
75+
<property name="tokens" value="DOT"/>
76+
</module>
77+
<module name="SeparatorWrap">
78+
<property name="id" value="SeparatorWrapComma"/>
79+
<property name="option" value="EOL"/>
80+
<property name="tokens" value="COMMA"/>
81+
</module>
82+
<module name="SeparatorWrap">
83+
<property name="id" value="SeparatorWrapEllipsis"/>
84+
<property name="option" value="EOL"/>
85+
<property name="tokens" value="ELLIPSIS"/>
86+
</module>
87+
<module name="SeparatorWrap">
88+
<property name="id" value="SeparatorWrapArrayDeclarator"/>
89+
<property name="option" value="EOL"/>
90+
<property name="tokens" value="ARRAY_DECLARATOR"/>
91+
</module>
92+
<module name="SeparatorWrap">
93+
<property name="id" value="SeparatorWrapMethodRef"/>
94+
<property name="option" value="nl"/>
95+
<property name="tokens" value="METHOD_REF"/>
96+
</module>
97+
<module name="PackageName">
98+
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
99+
<message key="name.invalidPattern" value="Package name ''{0}'' must match pattern ''{1}''."/>
100+
</module>
101+
<module name="TypeName">
102+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF"/>
103+
<message key="name.invalidPattern" value="Type name ''{0}'' must match pattern ''{1}''."/>
104+
</module>
105+
<module name="MemberName">
106+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9]*$"/>
107+
<message key="name.invalidPattern" value="Member name ''{0}'' must match pattern ''{1}''."/>
108+
</module>
109+
<module name="ParameterName">
110+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
111+
<message key="name.invalidPattern" value="Parameter name ''{0}'' must match pattern ''{1}''."/>
112+
</module>
113+
<module name="LambdaParameterName">
114+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
115+
<message key="name.invalidPattern" value="Lambda parameter name ''{0}'' must match pattern ''{1}''."/>
116+
</module>
117+
<module name="CatchParameterName">
118+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
119+
<message key="name.invalidPattern" value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
120+
</module>
121+
<module name="LocalVariableName">
122+
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
123+
<message key="name.invalidPattern" value="Local variable name ''{0}'' must match pattern ''{1}''."/>
124+
</module>
125+
<module name="ClassTypeParameterName">
126+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
127+
<message key="name.invalidPattern" value="Class type name ''{0}'' must match pattern ''{1}''."/>
128+
</module>
129+
<module name="MethodTypeParameterName">
130+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
131+
<message key="name.invalidPattern" value="Method type name ''{0}'' must match pattern ''{1}''."/>
132+
</module>
133+
<module name="InterfaceTypeParameterName">
134+
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/>
135+
<message key="name.invalidPattern" value="Interface type name ''{0}'' must match pattern ''{1}''."/>
136+
</module>
137+
<module name="NoFinalizer"/>
138+
<module name="GenericWhitespace">
139+
<message key="ws.notPreceded" value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
140+
<message key="ws.followed" value="GenericWhitespace ''{0}'' is followed by whitespace."/>
141+
<message key="ws.preceded" value="GenericWhitespace ''{0}'' is preceded with whitespace."/>
142+
<message key="ws.illegalFollow" value="GenericWhitespace ''{0}'' should followed by whitespace."/>
143+
</module>
144+
<module name="Indentation">
145+
<property name="caseIndent" value="0"/>
146+
</module>
147+
<module name="AbbreviationAsWordInName">
148+
<property name="allowedAbbreviationLength" value="1"/>
149+
<property name="ignoreFinal" value="false"/>
150+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF"/>
151+
</module>
152+
<module name="OverloadMethodsDeclarationOrder"/>
153+
<module name="VariableDeclarationUsageDistance"/>
154+
<module name="CustomImportOrder">
155+
<property name="customImportOrderRules" value="STATIC###THIRD_PARTY_PACKAGE"/>
156+
<property name="sortImportsInGroupAlphabetically" value="true"/>
157+
</module>
158+
<module name="MethodParamPad">
159+
<property name="tokens" value="CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF, SUPER_CTOR_CALL, ENUM_CONSTANT_DEF"/>
160+
</module>
161+
<module name="NoWhitespaceBefore">
162+
<property name="allowLineBreaks" value="true"/>
163+
<property name="tokens" value="COMMA, SEMI, POST_INC, POST_DEC, DOT, ELLIPSIS, METHOD_REF"/>
164+
</module>
165+
<module name="ParenPad">
166+
<property name="tokens" value="ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF, EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL, METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA"/>
167+
</module>
168+
<module name="OperatorWrap">
169+
<property name="option" value="NL"/>
170+
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR, METHOD_REF "/>
171+
</module>
172+
<module name="AnnotationLocation">
173+
<property name="id" value="AnnotationLocationMostCases"/>
174+
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
175+
</module>
176+
<module name="AnnotationLocation">
177+
<property name="id" value="AnnotationLocationVariables"/>
178+
<property name="tokens" value="VARIABLE_DEF"/>
179+
<property name="allowSamelineMultipleAnnotations" value="true"/>
180+
</module>
181+
<module name="NonEmptyAtclauseDescription"/>
182+
<module name="InvalidJavadocPosition"/>
183+
<module name="JavadocTagContinuationIndentation"/>
184+
<module name="SummaryJavadoc">
185+
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
186+
</module>
187+
<module name="JavadocParagraph"/>
188+
<module name="AtclauseOrder">
189+
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
190+
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
191+
</module>
192+
<module name="JavadocMethod">
193+
<property name="allowedAnnotations" value="Override, Test"/>
194+
<property name="scope" value="public"/>
195+
<property name="allowMissingParamTags" value="true"/>
196+
<property name="allowMissingReturnTag" value="true"/>
197+
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
198+
</module>
199+
<module name="MissingJavadocMethod">
200+
<property name="minLineCount" value="2"/>
201+
<property name="allowedAnnotations" value="Override, Test"/>
202+
<property name="scope" value="public"/>
203+
<property name="tokens" value="METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF"/>
204+
</module>
205+
<module name="MethodName">
206+
<property name="format" value="^[a-z][a-z0-9][a-zA-Z0-9_]*$"/>
207+
<message key="name.invalidPattern" value="Method name ''{0}'' must match pattern ''{1}''."/>
208+
</module>
209+
<module name="SingleLineJavadoc">
210+
<property name="ignoreInlineTags" value="false"/>
211+
</module>
212+
<module name="EmptyCatchBlock">
213+
<property name="exceptionVariableName" value="expected"/>
214+
</module>
215+
<module name="CommentsIndentation">
216+
<property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
217+
</module>
218+
<module name="SuppressionCommentFilter"/>
219+
</module>
220+
<module name="BeforeExecutionExclusionFileFilter">
221+
<property name="fileNamePattern" value="module\-info\.java$"/>
222+
</module>
223+
<module name="FileTabCharacter">
224+
<property name="eachLine" value="true"/>
225+
</module>
226+
<module name="LineLength">
227+
<property name="fileExtensions" value="java"/>
228+
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
229+
<property name="max" value="100"/>
230+
</module>
231+
</module>

‎module/core/pom.xml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
Copyright 2019 David MacCormack
4+
5+
Licensed under the Apache License, Version 2.0 (the "License"); you may not
6+
use this file except in compliance with the License. You may obtain a copy
7+
of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing,
12+
software distributed under the License is distributed on an
13+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
KIND, either express or implied. See the License for the
15+
specific language governing permissions and limitations
16+
under the License.
17+
-->
18+
19+
<project xmlns="http://maven.apache.org/POM/4.0.0"
20+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
21+
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
22+
<modelVersion>4.0.0</modelVersion>
23+
24+
<parent>
25+
<groupId>org.jsonurl</groupId>
26+
<artifactId>parent</artifactId>
27+
<version>1</version>
28+
</parent>
29+
30+
<artifactId>core</artifactId>
31+
<version>1.0.0-SNAPSHOT</version>
32+
<packaging>jar</packaging>
33+
34+
<name>${project.groupId}:${project.artifactId}</name>
35+
<description>
36+
${jsonurl.description}
37+
38+
This is the JSON->URL core library. It implements a parser, as defined
39+
by the spec, with support for type parameters. Implementations for
40+
specific APIs (e.g. JSR-374) leverage this and simply supply their own
41+
types.
42+
43+
You likely wont depend on this directly unless you're implementing
44+
JSON->URL with a new interface/library/framework.
45+
</description>
46+
</project>

0 commit comments

Comments
 (0)