X-Git-Url: http://git.ieval.ro/?a=blobdiff_plain;f=src%2Fcom%2Fgoogle%2Fgson%2FTypeAdapterFactory.java;fp=src%2Fcom%2Fgoogle%2Fgson%2FTypeAdapterFactory.java;h=536427f45739e9edc205dfe8d1fe2ef705713abc;hb=cfd903b6b5113fa28991db19bf98d0340ae709a4;hp=0000000000000000000000000000000000000000;hpb=819197b2305a94ab4924c5ae37a3fad762078448;p=unical.git diff --git a/src/com/google/gson/TypeAdapterFactory.java b/src/com/google/gson/TypeAdapterFactory.java new file mode 100644 index 0000000..536427f --- /dev/null +++ b/src/com/google/gson/TypeAdapterFactory.java @@ -0,0 +1,170 @@ +/* + * Copyright (C) 2011 Google 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.google.gson; + +import com.google.gson.reflect.TypeToken; + +/** + * Creates type adapters for set of related types. Type adapter factories are + * most useful when several types share similar structure in their JSON form. + * + *
{@code + * + * public class LowercaseEnumTypeAdapterFactory implements TypeAdapter.Factory { + * public+ * + *TypeAdapter create(Gson gson, TypeToken type) { + * Class rawType = (Class ) type.getRawType(); + * if (!rawType.isEnum()) { + * return null; + * } + * + * final Map lowercaseToConstant = new HashMap (); + * for (T constant : rawType.getEnumConstants()) { + * lowercaseToConstant.put(toLowercase(constant), constant); + * } + * + * return new TypeAdapter () { + * public void write(JsonWriter out, T value) throws IOException { + * if (value == null) { + * out.nullValue(); + * } else { + * out.value(toLowercase(value)); + * } + * } + * + * public T read(JsonReader reader) throws IOException { + * if (reader.peek() == JsonToken.NULL) { + * reader.nextNull(); + * return null; + * } else { + * return lowercaseToConstant.get(reader.nextString()); + * } + * } + * }; + * } + * + * private String toLowercase(Object o) { + * return o.toString().toLowerCase(Locale.US); + * } + * } + * }
Type adapter factories select which types they provide type adapters + * for. If a factory cannot support a given type, it must return null when + * that type is passed to {@link #create}. Factories should expect {@code + * create()} to be called on them for many types and should return null for + * most of those types. In the above example the factory returns null for + * calls to {@code create()} where {@code type} is not an enum. + * + *
A factory is typically called once per type, but the returned type + * adapter may be used many times. It is most efficient to do expensive work + * like reflection in {@code create()} so that the type adapter's {@code + * read()} and {@code write()} methods can be very fast. In this example the + * mapping from lowercase name to enum value is computed eagerly. + * + *
As with type adapters, factories must be registered with a {@link + * com.google.gson.GsonBuilder} for them to take effect:
{@code + * + * GsonBuilder builder = new GsonBuilder(); + * builder.registerTypeAdapterFactory(new LowercaseEnumTypeAdapterFactory()); + * ... + * Gson gson = builder.create(); + * }+ * If multiple factories support the same type, the factory registered earlier + * takes precedence. + * + *
The type adapter delegates to another type adapter for the + * multiset elements. It figures out the element type by reflecting on the + * multiset's type token. A {@code Gson} is passed in to {@code create} for + * just this purpose:
{@code + * + * public class MultisetTypeAdapterFactory implements TypeAdapter.Factory { + * public+ * Delegating from one type adapter to another is extremely powerful; it's + * the foundation of how Gson converts Java objects and collections. Whenever + * possible your factory should retrieve its delegate type adapter in the + * {@code create()} method; this ensures potentially-expensive type adapter + * creation happens only once. + * + * @since 2.1 + */ +public interface TypeAdapterFactory { + + /** + * Returns a type adapter for {@code type}, or null if this factory doesn't + * support {@code type}. + */ +TypeAdapter create(Gson gson, TypeToken typeToken) { + * Type type = typeToken.getType(); + * if (typeToken.getRawType() != Multiset.class + * || !(type instanceof ParameterizedType)) { + * return null; + * } + * + * Type elementType = ((ParameterizedType) type).getActualTypeArguments()[0]; + * TypeAdapter> elementAdapter = gson.getAdapter(TypeToken.get(elementType)); + * return (TypeAdapter ) newMultisetAdapter(elementAdapter); + * } + * + * private TypeAdapter > newMultisetAdapter( + * final TypeAdapter elementAdapter) { + * return new TypeAdapter >() { + * public void write(JsonWriter out, Multiset value) throws IOException { + * if (value == null) { + * out.nullValue(); + * return; + * } + * + * out.beginArray(); + * for (Multiset.Entry entry : value.entrySet()) { + * out.value(entry.getCount()); + * elementAdapter.write(out, entry.getElement()); + * } + * out.endArray(); + * } + * + * public Multiset read(JsonReader in) throws IOException { + * if (in.peek() == JsonToken.NULL) { + * in.nextNull(); + * return null; + * } + * + * Multiset result = LinkedHashMultiset.create(); + * in.beginArray(); + * while (in.hasNext()) { + * int count = in.nextInt(); + * E element = elementAdapter.read(in); + * result.add(element, count); + * } + * in.endArray(); + * return result; + * } + * }; + * } + * } + * }