-
Notifications
You must be signed in to change notification settings - Fork 970
Add extra safety to unmarshaling to enums. #38
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| /* | ||
| * Copyright 2014 Google Inc. All rights reserved. | ||
| * | ||
| * | ||
| * 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.maps.internal; | ||
|
|
||
| import com.google.gson.TypeAdapter; | ||
| import com.google.gson.stream.JsonReader; | ||
| import com.google.gson.stream.JsonToken; | ||
| import com.google.gson.stream.JsonWriter; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Locale; | ||
| import java.util.logging.Logger; | ||
|
|
||
| /** | ||
| * A {@link com.google.gson.TypeAdapter} that maps case-insensitive values to an enum type. If the | ||
| * value is not found, an UNKNOWN value is returned, and logged. This allows the server to return | ||
| * values this client doesn't yet know about. | ||
| * @param <E> the enum type to map values to. | ||
| */ | ||
| public class SafeEnumAdapter<E extends Enum<E>> extends TypeAdapter<E> { | ||
|
|
||
| private static Logger log = Logger.getLogger(SafeEnumAdapter.class.getName()); | ||
|
|
||
| private final Class<E> clazz; | ||
| private final E unknownValue; | ||
|
|
||
| /** | ||
| * @param unknownValue the value to return if the value cannot be found. | ||
| */ | ||
| public SafeEnumAdapter(E unknownValue) { | ||
| if (unknownValue == null) throw new IllegalArgumentException(); | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Cheeky. The style guide says no (but I say yes).
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Me too. |
||
|
|
||
| this.unknownValue = unknownValue; | ||
| this.clazz = unknownValue.getDeclaringClass(); | ||
| } | ||
|
|
||
| @Override | ||
| public void write(JsonWriter out, E value) throws IOException { | ||
| throw new UnsupportedOperationException("Unimplemented method"); | ||
| } | ||
|
|
||
| @Override | ||
| public E read(JsonReader reader) throws IOException { | ||
| if (reader.peek() == JsonToken.NULL) { | ||
| reader.nextNull(); | ||
| return null; | ||
| } | ||
| String value = reader.nextString(); | ||
| try { | ||
| return Enum.valueOf(clazz, value.toUpperCase(Locale.ENGLISH)); | ||
| } catch (IllegalArgumentException iae) { | ||
| log.warning(String.format("Unknown type for enum %s: '%s'", clazz.getName(), value)); | ||
| return unknownValue; | ||
| } | ||
| } | ||
| } | ||
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Include the copyright
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done