Initial round of Moshi docs.

examples/pom.xml

@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>com.squareup.moshi</groupId>
+    <artifactId>moshi-parent</artifactId>
+    <version>0.1-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>moshi-examples</artifactId>
+
+  <dependencies>
+    <dependency>
+      <groupId>com.squareup.moshi</groupId>
+      <artifactId>moshi</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+  </dependencies>
+</project>

examples/src/main/java/com/squareup/moshi/recipes/BlackjackHand.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright (C) 2015 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.squareup.moshi.recipes;
+
+import java.util.List;
+
+public final class BlackjackHand {
+  public final Card hidden_card;
+  public final List<Card> visible_cards;
+
+  public BlackjackHand(Card hidden_card, List<Card> visible_cards) {
+    this.hidden_card = hidden_card;
+    this.visible_cards = visible_cards;
+  }
+
+  @Override public String toString() {
+    return "hidden=" + hidden_card + ",visible=" + visible_cards;
+  }
+}

examples/src/main/java/com/squareup/moshi/recipes/Card.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright (C) 2015 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.squareup.moshi.recipes;
+
+public final class Card {
+  public final char rank;
+  public final Suit suit;
+
+  public Card(char rank, Suit suit) {
+    this.rank = rank;
+    this.suit = suit;
+  }
+
+  @Override public String toString() {
+    return String.format("%s%s", rank, suit);
+  }
+}

examples/src/main/java/com/squareup/moshi/recipes/CardAdapter.java

@@ -0,0 +1,39 @@
+/*
+ * Copyright (C) 2015 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.squareup.moshi.recipes;
+
+import com.squareup.moshi.FromJson;
+import com.squareup.moshi.JsonDataException;
+import com.squareup.moshi.ToJson;
+
+public final class CardAdapter {
+  @ToJson String toJson(Card card) {
+    return card.rank + card.suit.name().substring(0, 1);
+  }
+
+  @FromJson Card fromJson(String card) {
+    if (card.length() != 2) throw new JsonDataException("Unknown card: " + card);
+
+    char rank = card.charAt(0);
+    switch (card.charAt(1)) {
+      case 'C': return new Card(rank, Suit.CLUBS);
+      case 'D': return new Card(rank, Suit.DIAMONDS);
+      case 'H': return new Card(rank, Suit.HEARTS);
+      case 'S': return new Card(rank, Suit.SPADES);
+      default: throw new JsonDataException("unknown suit: " + card);
+    }
+  }
+}

examples/src/main/java/com/squareup/moshi/recipes/CustomTypeAdapter.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (C) 2015 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.squareup.moshi.recipes;
+
+import com.squareup.moshi.JsonAdapter;
+import com.squareup.moshi.Moshi;
+
+public final class CustomTypeAdapter {
+  public void run() throws Exception {
+    String json = ""
+        + "{\n"
+        + "  \"hidden_card\": \"6S\",\n"
+        + "  \"visible_cards\": [\n"
+        + "    \"4C\",\n"
+        + "    \"AH\"\n"
+        + "  ]\n"
+        + "}\n";
+
+    Moshi moshi = new Moshi.Builder()
+        .add(new CardAdapter())
+        .build();
+    JsonAdapter<BlackjackHand> jsonAdapter = moshi.adapter(BlackjackHand.class);
+
+    BlackjackHand blackjackHand = jsonAdapter.fromJson(json);
+    System.out.println(blackjackHand);
+  }
+
+  public static void main(String[] args) throws Exception {
+    new CustomTypeAdapter().run();
+  }
+}

examples/src/main/java/com/squareup/moshi/recipes/ReadJson.java

@@ -0,0 +1,51 @@
+/*
+ * Copyright (C) 2015 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.squareup.moshi.recipes;
+
+import com.squareup.moshi.JsonAdapter;
+import com.squareup.moshi.Moshi;
+
+public final class ReadJson {
+  public void run() throws Exception {
+    String json = "" 
+        + "{\n"
+        + "  \"hidden_card\": {\n"
+        + "    \"rank\": \"6\",\n"
+        + "    \"suit\": \"SPADES\"\n"
+        + "  },\n"
+        + "  \"visible_cards\": [\n"
+        + "    {\n"
+        + "      \"rank\": \"4\",\n"
+        + "      \"suit\": \"CLUBS\"\n"
+        + "    },\n"
+        + "    {\n"
+        + "      \"rank\": \"A\",\n"
+        + "      \"suit\": \"HEARTS\"\n"
+        + "    }\n"
+        + "  ]\n"
+        + "}\n";
+
+    Moshi moshi = new Moshi.Builder().build();
+    JsonAdapter<BlackjackHand> jsonAdapter = moshi.adapter(BlackjackHand.class);
+
+    BlackjackHand blackjackHand = jsonAdapter.fromJson(json);
+    System.out.println(blackjackHand);
+  }
+
+  public static void main(String[] args) throws Exception {
+    new ReadJson().run();
+  }
+}

examples/src/main/java/com/squareup/moshi/recipes/Suit.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright (C) 2015 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.squareup.moshi.recipes;
+
+public enum Suit {
+  CLUBS, DIAMONDS, HEARTS, SPADES;
+
+  @Override public String toString() {
+    return name().substring(0, 1);
+  }
+}

examples/src/main/java/com/squareup/moshi/recipes/WriteJson.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright (C) 2015 Square, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.squareup.moshi.recipes;
+
+import com.squareup.moshi.JsonAdapter;
+import com.squareup.moshi.Moshi;
+import java.util.Arrays;
+
+import static com.squareup.moshi.recipes.Suit.CLUBS;
+import static com.squareup.moshi.recipes.Suit.HEARTS;
+import static com.squareup.moshi.recipes.Suit.SPADES;
+
+public final class WriteJson {
+  public void run() throws Exception {
+    BlackjackHand blackjackHand = new BlackjackHand(
+        new Card('6', SPADES),
+        Arrays.asList(new Card('4', CLUBS), new Card('A', HEARTS)));
+
+    Moshi moshi = new Moshi.Builder().build();
+    JsonAdapter<BlackjackHand> jsonAdapter = moshi.adapter(BlackjackHand.class);
+
+    String json = jsonAdapter.toJson(blackjackHand);
+    System.out.println(json);
+  }
+
+  public static void main(String[] args) throws Exception {
+    new WriteJson().run();
+  }
+}