google-nomulus/java/google/registry/model/translators/EnumToAttributeAdapter.java
Justine Tunney 6f4b059cc9 Make javadoc <p> style guide compliant
This led to confusion for an open source contributor about how to format
code. We don't want to be like, "do as I say, not as I do."

https://google.github.io/styleguide/javaguide.html#s7.1.2-javadoc-paragraphs
-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=122589700
2016-05-18 13:09:01 -04:00

56 lines
1.8 KiB
Java

// Copyright 2016 The Domain Registry Authors. 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 google.registry.model.translators;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.adapters.XmlAdapter;
/**
* Used by JAXB to convert enums to the peculiar EPP format that puts the value in an attribute.
*
* @param <E> the enum type
*/
public class EnumToAttributeAdapter<E extends Enum<E> & EnumToAttributeAdapter.EppEnum>
extends XmlAdapter<EnumToAttributeAdapter.EnumShim, E> {
/** Interface for epp enums that can be transformed with this adapter. */
public interface EppEnum {
String getXmlName();
}
/**
* EPP's peculiar enum format.
*
* <p>It's meant to allow more information inside the element, but it's an annoyance when we want
* to deal with pure enums.
*/
static class EnumShim {
@XmlAttribute
String s;
}
// Enums that can be unmarshalled from input can override this.
@Override
public E unmarshal(EnumShim shim) throws Exception {
throw new UnsupportedOperationException();
}
@Override
public final EnumShim marshal(E enumeration) throws Exception {
EnumShim shim = new EnumShim();
shim.s = enumeration.getXmlName();
return shim;
}
}