A bunch of Javadoc fixes.
This commit is contained in:
@@ -104,10 +104,10 @@ public class Transformers
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Combines the contents of a List/Set/Collection/Iterable<String> column into a single String,
|
* Combines the contents of a {@code List/Set/Collection/Iterable<String>} column into a single
|
||||||
* terminating each String element with a newline. Null-tolerant.
|
* String, terminating each String element with a newline. Null-tolerant. A backslash ('\') in
|
||||||
* A backslash ('\') in Strings will be prefixed by another backslash, newlines will be
|
* Strings will be prefixed by another backslash, newlines will be encoded as "\n", and null
|
||||||
* encoded as "\n", and null elements will be encoded as "\0" (but not terminated by a newline).
|
* elements will be encoded as "\0" (but not terminated by a newline).
|
||||||
*/
|
*/
|
||||||
public static class StringIterable extends StringBase<Iterable<String>>
|
public static class StringIterable extends StringBase<Iterable<String>>
|
||||||
{
|
{
|
||||||
@@ -123,8 +123,7 @@ public class Transformers
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A Transformer for anything that is an Iterable<Enum>.
|
* A Transformer for anything that is an {@code Iterable<Enum>}. Often used for Enum sets.
|
||||||
* Often used for Enum sets.
|
|
||||||
*/
|
*/
|
||||||
public static class EnumIterable<E extends Enum<E>> extends StringBase<Iterable<E>>
|
public static class EnumIterable<E extends Enum<E>> extends StringBase<Iterable<E>>
|
||||||
{
|
{
|
||||||
|
|||||||
@@ -22,15 +22,18 @@ public @interface Index
|
|||||||
* <p>If this annotation is on a field, an index is created for all fields annotated with this
|
* <p>If this annotation is on a field, an index is created for all fields annotated with this
|
||||||
* name in the order of the fields in the class.</p>
|
* name in the order of the fields in the class.</p>
|
||||||
*
|
*
|
||||||
* <p>If this annotation is on a {@code PersistentRecord} class, a static method must be
|
* <p>If this annotation is on a {@code PersistentRecord} class, a static method must be defined
|
||||||
* defined in that class that provides the index configuration. The method must match one of
|
* in that class that provides the index configuration. The method must match one of the
|
||||||
* the following two signatures:
|
* following two signatures:</p>
|
||||||
* <pre>
|
*
|
||||||
|
* <pre>{@code
|
||||||
* public static ColumnExp<?>[] indexName ()
|
* public static ColumnExp<?>[] indexName ()
|
||||||
* public static List<Tuple<SQLExpression, OrderBy.Order>> indexName ()
|
* public static List<Tuple<SQLExpression, OrderBy.Order>> indexName ()
|
||||||
* </pre>
|
* }</pre>
|
||||||
* The first form will result in a simple multicolum index being created with the supplied
|
*
|
||||||
* columns. The second will create a function index using the supplied {@code SQLExpression}s.</p>
|
* <p>The first form will result in a simple multicolum index being created with the supplied
|
||||||
|
* columns. The second will create a function index using the supplied {@code
|
||||||
|
* SQLExpression}s.</p>
|
||||||
*/
|
*/
|
||||||
String name () default "";
|
String name () default "";
|
||||||
|
|
||||||
|
|||||||
@@ -19,7 +19,7 @@ import com.samskivert.depot.Transformer;
|
|||||||
* saving to the database and after loading from the database.
|
* saving to the database and after loading from the database.
|
||||||
*
|
*
|
||||||
* <p> For example, one may choose to transform a particular persistent record field into a type
|
* <p> For example, one may choose to transform a particular persistent record field into a type
|
||||||
* supported directly by Depot:
|
* supported directly by Depot:</p>
|
||||||
*
|
*
|
||||||
* <pre>
|
* <pre>
|
||||||
* public class MyRecord extends PersistentRecord {
|
* public class MyRecord extends PersistentRecord {
|
||||||
@@ -28,17 +28,18 @@ import com.samskivert.depot.Transformer;
|
|||||||
* }
|
* }
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
* or one may opt to specify a transformation for all fields that contain a value of a particular
|
* <p>or one may opt to specify a transformation for all fields that contain a value of a particular
|
||||||
* type:
|
* type:</p>
|
||||||
*
|
*
|
||||||
* <pre>
|
* <pre>
|
||||||
* @Transform(ByteEnumTransformer.class)
|
* @Transform(ByteEnumTransformer.class)
|
||||||
* public interface ByteEnum { ... }
|
* public interface ByteEnum { ... }
|
||||||
* </pre>
|
* </pre>
|
||||||
*
|
*
|
||||||
* Note that because Depot honors @Transform annotations on any interface implemented by a type, or
|
* <p>Note that because Depot honors @Transform annotations on any interface implemented by a type,
|
||||||
* on a type's superclass, it is possible that conflicting transformations may be specified. In
|
* or on a type's superclass, it is possible that conflicting transformations may be specified. In
|
||||||
* this case, Depot will fail with a runtime error during initialization, to indicate the problem.
|
* this case, Depot will fail with a runtime error during initialization, to indicate the
|
||||||
|
* problem.</p>
|
||||||
*
|
*
|
||||||
* @see Transformer
|
* @see Transformer
|
||||||
*/
|
*/
|
||||||
|
|||||||
@@ -11,9 +11,8 @@ import com.samskivert.depot.expression.SQLExpression;
|
|||||||
import com.samskivert.depot.impl.FragmentVisitor;
|
import com.samskivert.depot.impl.FragmentVisitor;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Represents a DISTINCT [ON <exp>] clause.
|
* Represents a {@code DISTINCT [ON <exp>]} clause. Note: You almost certainly only ever want to use
|
||||||
*
|
* this in a SELECT statement.
|
||||||
* Note: You almost certainly only ever want to use this in a SELECT statement.
|
|
||||||
*/
|
*/
|
||||||
public class Distinct implements QueryClause
|
public class Distinct implements QueryClause
|
||||||
{
|
{
|
||||||
|
|||||||
Reference in New Issue
Block a user