Log Message
Improve javadoc.
Modified Paths
Diff
Modified: trunk/xstream/src/java/com/thoughtworks/xstream/annotations/XStreamAlias.java (2097 => 2098)
--- trunk/xstream/src/java/com/thoughtworks/xstream/annotations/XStreamAlias.java 2013-07-12 16:45:09 UTC (rev 2097)
+++ trunk/xstream/src/java/com/thoughtworks/xstream/annotations/XStreamAlias.java 2013-07-12 17:18:59 UTC (rev 2098)
@@ -1,6 +1,6 @@
/*
* Copyright (C) 2005 Joe Walnes.
- * Copyright (C) 2006, 2007 XStream Committers.
+ * Copyright (C) 2006, 2007, 2013 XStream Committers.
* All rights reserved.
*
* The software in this package is published under the terms of the BSD
@@ -17,17 +17,23 @@
import java.lang.annotation.Target;
/**
- * Annotation used to define an XStream class or field value.
+ * Annotation used to define an XStream class or field alias.
*
* @author Emil Kirschner
* @author Chung-Onn Cheong
+ * @see com.thoughtworks.xstream.XStream#alias(String, Class)
+ * @see com.thoughtworks.xstream.XStream#alias(String, Class, Class)
+ * @see com.thoughtworks.xstream.XStream#addDefaultImplementation(Class, Class)
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.FIELD})
public @interface XStreamAlias {
/**
- * The value of the class or field value
+ * The name of the class or field alias.
*/
public String value();
+ /**
+ * A possible default implementation if the annotated type is an interface.
+ */
public Class<?> impl() default Void.class; //Use Void to denote as Null
}
To unsubscribe from this list please visit:
