Skip to content

Commit

Permalink
Fix javadoc issues
Browse files Browse the repository at this point in the history
  • Loading branch information
Emil Forslund committed May 26, 2016
1 parent 0ba0958 commit ea48cca
Show file tree
Hide file tree
Showing 12 changed files with 48 additions and 53 deletions.
3 changes: 1 addition & 2 deletions runtime/src/main/java/com/speedment/runtime/Speedment.java
Expand Up @@ -76,12 +76,11 @@ public interface Speedment {
* Puts a new Component in the Speedment platform and returns the previous
* Component (if any) with the same interface class.
*
* @param <R> The Component type
* @param item the new Component to put
* @return the previous Component registered using that interface class, or
* null of no one existed before
*/
<R extends Component> R put(R item);
Component put(Component item);

//Component put(Component item);
/**
Expand Down
Expand Up @@ -26,8 +26,8 @@
/**
* This class is a pluggable factory that produces
* {@link DbmsHandler DbmsHandlers} for a given Dbms. The DbmsHandler is
* obtained via the {@link #get(com.speedment.runtime.config.db.Dbms) } method and if an
* existing DbmsHandler can not be found, the {@link #make(com.speedment.runtime.config.db.Dbms)
* obtained via the {@link #get(com.speedment.runtime.config.Dbms) } method and if an
* existing DbmsHandler can not be found, the {@link #make(com.speedment.runtime.config.Dbms)
* } method is called to provide a new instance.
*
* @author pemi
Expand All @@ -38,7 +38,7 @@ public interface DbmsHandlerComponent extends Component {

/**
* Installs a new {@link DbmsType} so that handlers can be created using the
* {@link #make(com.speedment.runtime.config.db.Dbms) } method.
* {@link #make(com.speedment.runtime.config.Dbms) } method.
* <p>
* The type will be indexed by its name as returned by
* {@link DbmsType#getName() }. If multiple {@code DbmsTypes} share name,
Expand Down
@@ -1,5 +1,5 @@
/**
* Implementations of the {@link com.speedment.runtime.config.db.mapper.TypeMapper}
* Implementations of the {@link com.speedment.runtime.config.mapper.TypeMapper}
* interface that simply map to and from the same type is located in this
* package. These are normally the default mappers used if no other is
* specified.
Expand Down
@@ -1,5 +1,5 @@
/**
* Implementations of the {@link com.speedment.runtime.config.db.mapper.TypeMapper}
* Implementations of the {@link com.speedment.runtime.config.mapper.TypeMapper}
* interface that map from strings to other types are located in this package.
* <p>
* This package is part of the API. Modifications to classes here should only
Expand Down
@@ -1,5 +1,5 @@
/**
* Implementations of the {@link com.speedment.runtime.config.db.mapper.TypeMapper}
* Implementations of the {@link com.speedment.runtime.config.mapper.TypeMapper}
* interface that map from temporal types to other types are located in this
* package.
* <p>
Expand Down
@@ -1,5 +1,5 @@
/**
* Implementations of the {@link com.speedment.runtime.config.db.mutator.DocumentMutator}
* Implementations of the {@link com.speedment.runtime.config.mutator.DocumentMutator}
* interface that help modify a {@link com.speedment.runtime.config.Document} in a
* type-safe manner are located in this package.
* <p>
Expand Down
@@ -1,5 +1,5 @@
/**
* Common traits used by the {@link com.speedment.runtime.config.db.mutator.DocumentMutator}
* Common traits used by the {@link com.speedment.runtime.config.mutator.DocumentMutator}
* implementations are located in this package.
* <p>
* This package is part of the API. Modifications to classes here should only
Expand Down
Expand Up @@ -542,8 +542,8 @@ protected <T> void tableChilds(
* Sets the autoIncrement property of a Column.
*
* @param column to use
* @param rs that contains column metadata (per
* connection.getMetaData().getColumns(...))
* @param md that contains column metadata (per connection.getMetaData().getColumns(...))
* @throws SQLException if something goes wrong in JDBC
*/
protected void setAutoIncrement(Column column, ColumnMetaData md) throws SQLException {
final String isAutoIncrementString = md.getIsAutoincrement();
Expand All @@ -558,9 +558,8 @@ protected void setAutoIncrement(Column column, ColumnMetaData md) throws SQLExce
* Looks up a column {@code TYPE_NAME} and returns a mapped Class (e.g.
* {@code Timestamp} or {@code String}).
*
* @param typeName the TYPE_NAME value
* @param columnSize the COLUMN_SIZE value
* @param decimalDigits the DECIMAL_DIGITS value
* @param sqlTypeMapping the type mappings to use
* @param md that contains column metadata (per connection.getMetaData().getColumns(...))
* @return the mapped Class
*/
protected Class<?> lookupJdbcClass(Map<String, Class<?>> sqlTypeMapping, ColumnMetaData md) {
Expand All @@ -584,7 +583,7 @@ protected Class<?> lookupJdbcClass(Map<String, Class<?>> sqlTypeMapping, ColumnM
* Returns the schema lookup name used when calling
* connection.getMetaData().getXxxx(y, schemaLookupName, ...) methods.
*
* @param table to use
* @param schema to use
* @return the schema lookup name used when calling
* connection.getMetaData().getXxxx(y, schemaLookupName, ...) methods
*/
Expand All @@ -596,7 +595,7 @@ protected String jdbcSchemaLookupName(Schema schema) {
* Returns the catalog lookup name used when calling
* connection.getMetaData().getXxxx(catalogLookupName, ...) methods.
*
* @param table to use
* @param schema to use
* @return the catalog lookup name used when calling
* connection.getMetaData().getXxxx(catalogLookupName, ...) methods
*/
Expand Down

This file was deleted.

Expand Up @@ -84,7 +84,7 @@ public static void save(Project project, Path location) throws SpeedmentExceptio
* @param json the input json
* @return the parsed project
*
* @throws SpeedmentException
* @throws SpeedmentException if the file couldn't be loaded
*/
public static Project load(String json) throws SpeedmentException {
try {
Expand Down
Expand Up @@ -92,10 +92,10 @@ public static <E extends Document> Optional<E> ancestor(
* Returns a stream of child documents to a specified document by using the
* supplied constructor.
*
* @param <E> the expected child type
* @param document the parent document
* @param childConstructor child constructor
* @return
* @param <E> the expected child type
* @param document the parent document
* @param childConstructor child constructor
* @return stream of children
*/
@SuppressWarnings("unchecked")
public static <E extends Document> Stream<E> childrenOf(
Expand Down Expand Up @@ -180,12 +180,13 @@ public String of(HasAlias document) {
* For example, {@code relativeName(column, Dbms.class, DATABASE_NAME)}
* would return the String "dbms_name.schema_name.table_name.column_name".
*
* @param <T> parent type
* @param <D> document type
* @param document to use
* @param from class
* @return the relative name for this Node from the point given by the
* parent Class
* @param <T> parent type
* @param <D> document type
* @param document to use
* @param from the document type to get the name from
* @param name if java or database name should be used
* @return the relative name for this Node from the point given by the
* parent Class
*/
public static <T extends Document & HasName, D extends Document & HasName>
String relativeName(D document, Class<T> from, Name name) {
Expand All @@ -200,13 +201,14 @@ String relativeName(D document, Class<T> from, Name name) {
* For example, {@code relativeName(column, Dbms.class, DATABASE_NAME)}
* would return the String "dbms_name.schema_name.table_name.column_name".
*
* @param <T> parent type
* @param <D> Document type
* @param document to use
* @param from class
* @param <T> parent type
* @param <D> Document type
* @param document to use
* @param from class
* @param name if java or database name should be used
* @param nameMapper to apply to all names encountered during traversal
* @return the relative name for this Node from the point given by the
* parent Class
* @return the relative name for this Node from the point given by the
* parent Class
*/
public static <T extends Document & HasName, D extends Document & HasName>
String relativeName(
Expand All @@ -227,14 +229,15 @@ String relativeName(
* String "dbms_name.schema_name.table_name.column_name" if the separator is
* "."
*
* @param <T> parent type
* @param <D> Document type
* @param document to use
* @param from class
* @param separator to use between the document names
* @param nameMapper to apply to all names encountered during traversal
* @return the relative name for this Node from the point given by the
* parent Class
* @param <T> parent type
* @param <D> Document type
* @param document to use
* @param from class
* @param name if java or database name should be used
* @param separator to use between the document names
* @param nameMapper to apply to all names encountered during traversal
* @return the relative name for this Node from the point
* given by the parent Class
*/
public static <T extends Document & HasName, D extends Document & HasName> String relativeName(
D document,
Expand Down Expand Up @@ -264,11 +267,10 @@ public static <T extends Document & HasName, D extends Document & HasName> Strin
* Creates a deep copy of the raw map in the specified document and wrap it
* in a new typed document using the specified constructor.
*
* @param <P> the parent type
* @param <DOC> the document type
* @param document the document
* @param constructor the document constructor
* @return the copy
* @param <DOC> the document type
* @param document the document
* @param constructor the document constructor
* @return the copy
*/
public static <DOC extends Document> DOC deepCopy(
DOC document,
Expand Down
Expand Up @@ -19,7 +19,7 @@
* To change this template file, choose Tools | Templates
* and open the template in the editor.
*/
package com.speedment.runtime.config.db.parameters;
package com.speedment.runtime.config.parameters;

import com.speedment.runtime.config.parameter.OrderType;
import java.util.concurrent.atomic.AtomicBoolean;
Expand Down

0 comments on commit ea48cca

Please sign in to comment.