Skip to content

Commit

Permalink
Fix more javadoc and move document properties to public packages
Browse files Browse the repository at this point in the history
  • Loading branch information
Emil Forslund committed Mar 22, 2016
1 parent f4d075c commit f6051c3
Show file tree
Hide file tree
Showing 42 changed files with 103 additions and 54 deletions.
Expand Up @@ -22,7 +22,6 @@
import com.speedment.internal.codegen.model.AnnotationUsageImpl;
import java.util.List;
import java.util.Map;
import static java.util.Objects.requireNonNull;
import java.util.function.Function;
import com.speedment.codegen.model.trait.HasCopy;
import static java.util.Objects.requireNonNull;
Expand All @@ -41,7 +40,7 @@ public interface AnnotationUsage extends HasCopy<AnnotationUsage>,
/**
* Use the specified key-value pair when referencing the annotation. If you
* only want to show a single value without any key, consider using the
* {@link #set(com.speedment.codegen.lang.models.Value) set()} method.
* {@link #put(String, Value)} method.
*
* @param key the key
* @param val the value
Expand Down
@@ -1,6 +1,6 @@
/**
* Implementations of the
* {@link com.speedment.codegen.lang.models.modifiers.Modifier} interface that
* {@link com.speedment.codegen.model.modifier.Modifier} interface that
* represent the modifier keywords of the java language is located in this
* package.
* <p>
Expand Down
Expand Up @@ -7,7 +7,7 @@
* The interfaces in this package does not share a common ancestor. The reason
* for this is that any class should qualify as a model as long as a
* corresponding view is installed in the active
* {@link com.speedment.codegen.base.Generator}.
* {@link com.speedment.codegen.Generator}.
* <p>
* This package is part of the API. Modifications to classes here should only
* (if ever) be done in major releases.
Expand Down
Expand Up @@ -35,7 +35,7 @@ public interface HasMethodsView<M extends HasMethods<M>> extends Transform<M, St

/**
* Render the methods-part of the model separated with two new-line
* characters. The {@link #wrapMethod(com.speedment.codegen.lang.models.Method)}-method
* characters. The {@link #wrapMethod(Method)}-method
* can be overridden to change the implementation type of the methods before
* rendering.
*
Expand Down
Expand Up @@ -31,7 +31,7 @@
/**
* This is the default implementation of the {@link AnnotationUsage} interface.
* This class should not be instantiated directly. Instead you should call the
* {@link AnnotationUsage#of(com.speedment.codegen.lang.models.Type) } method to
* {@link AnnotationUsage#of(Type) } method to
* get an instance. In that way, you can layer change the implementing class
* without modifying the using code.
*
Expand All @@ -44,7 +44,7 @@ public final class AnnotationUsageImpl extends AnnotationUsageBase {
* Initializes this annotation usage using a type.
* <p>
* <b>Warning!</b> This class should not be instantiated directly but using
* the {@link AnnotationUsage#of(com.speedment.codegen.lang.models.Type)}
* the {@link AnnotationUsage#of(Type)}
* method!
*
* @param type the type
Expand Down
Expand Up @@ -34,9 +34,8 @@
/**
* This is the default implementation of the {@link Field} interface.
* This class should not be instantiated directly. Instead you should call the
* {@link Field#of(java.lang.String, com.speedment.codegen.lang.models.Type)}
* method to get an instance. In that way, you can layer change the implementing
* class without modifying the using code.
* {@link Field#of(String, Type)} method to get an instance. In that way, you
* can layer change the implementing class without modifying the using code.
*
* @author Emil Forslund
* @see Field
Expand All @@ -54,8 +53,7 @@ public final class FieldImpl implements Field {
* Initializes this field using a name and a type.
* <p>
* <b>Warning!</b> This class should not be instantiated directly but using
* the {@link Field#of(java.lang.String, com.speedment.codegen.lang.models.Type)}
* method!
* the {@link Field#of(String, Type)} method!
*
* @param name the name
* @param type the type
Expand Down
Expand Up @@ -29,9 +29,8 @@
/**
* This is the default implementation of the {@link Import} interface.
* This class should not be instantiated directly. Instead you should call the
* {@link Import#of(com.speedment.codegen.lang.models.Type)} method to get an
* instance. In that way, you can layer change the implementing class without
* modifying the using code.
* {@link Import#of(Type)} method to get an instance. In that way, you can layer
* change the implementing class without modifying the using code.
*
* @author Emil Forslund
* @see Import
Expand All @@ -46,7 +45,7 @@ public final class ImportImpl implements Import {
* Initializes this import using a type.
* <p>
* <b>Warning!</b> This class should not be instantiated directly but using
* the {@link Import#of(com.speedment.codegen.lang.models.Type)} method!
* the {@link Import#of(Type)} method!
* @param type the type
*/
Expand Down
Expand Up @@ -36,9 +36,8 @@
/**
* This is the default implementation of the {@link Method} interface.
* This class should not be instantiated directly. Instead you should call the
* {@link Method#of(java.lang.String, com.speedment.codegen.lang.models.Type)}
* method to get an instance. In that way, you can layer change the implementing
* class without modifying the using code.
* {@link Method#of(String, Type)} method to get an instance. In that way, you
* can layer change the implementing class without modifying the using code.
*
* @author Emil Forslund
* @see Method
Expand All @@ -59,8 +58,7 @@ public final class MethodImpl implements Method {
* Initializes this method using a name and a type.
* <p>
* <b>Warning!</b> This class should not be instantiated directly but using
* the {@link Method#of(java.lang.String, com.speedment.codegen.lang.models.Type)}
* method!
* the {@link Method#of(String, Type)} method!
*
* @param name the name
* @param type the type
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/speedment/internal/ui/UISession.java
Expand Up @@ -39,7 +39,7 @@
import static com.speedment.internal.ui.util.OutputUtil.error;
import static com.speedment.internal.ui.util.OutputUtil.info;
import static com.speedment.internal.ui.util.OutputUtil.success;
import com.speedment.internal.ui.property.PropertySheetFactory; // Exposes internal
import com.speedment.ui.config.db.PropertySheetFactory; // Exposes internal
import com.speedment.internal.util.Settings;
import com.speedment.internal.util.testing.Stopwatch;
import java.io.File;
Expand Down
Expand Up @@ -28,8 +28,8 @@
import com.speedment.ui.config.trait.HasEnabledProperty;
import com.speedment.ui.config.trait.HasNameProperty;
import com.speedment.ui.config.trait.HasNullableProperty;
import com.speedment.internal.ui.property.BooleanPropertyItem;
import com.speedment.internal.ui.property.TypeMapperPropertyItem;
import com.speedment.ui.config.db.BooleanPropertyItem;
import com.speedment.ui.config.db.TypeMapperPropertyItem;
import java.util.Optional;
import java.util.stream.Stream;
import static javafx.beans.binding.Bindings.createObjectBinding;
Expand Down
Expand Up @@ -32,10 +32,10 @@
import com.speedment.ui.config.trait.HasEnabledProperty;
import com.speedment.ui.config.trait.HasExpandedProperty;
import com.speedment.ui.config.trait.HasNameProperty;
import com.speedment.internal.ui.property.StringChoicePropertyItem;
import com.speedment.internal.ui.property.DefaultIntegerPropertyItem;
import com.speedment.internal.ui.property.DefaultStringPropertyItem;
import com.speedment.internal.ui.property.DefaultTextAreaPropertyItem;
import com.speedment.ui.config.db.StringChoicePropertyItem;
import com.speedment.ui.config.db.DefaultIntegerPropertyItem;
import com.speedment.ui.config.db.DefaultStringPropertyItem;
import com.speedment.ui.config.db.DefaultTextAreaPropertyItem;
import java.util.Optional;
import java.util.OptionalInt;
import static java.util.stream.Collectors.toList;
Expand Down
Expand Up @@ -24,7 +24,7 @@
import com.speedment.ui.config.trait.HasColumnProperty;
import com.speedment.ui.config.trait.HasNameProperty;
import com.speedment.ui.config.trait.HasOrdinalPositionProperty;
import com.speedment.internal.ui.property.StringPropertyItem;
import com.speedment.ui.config.db.StringPropertyItem;
import java.util.stream.Stream;
import static javafx.beans.binding.Bindings.createObjectBinding;
import javafx.beans.binding.ObjectBinding;
Expand Down
Expand Up @@ -26,7 +26,7 @@
import com.speedment.ui.config.trait.HasEnabledProperty;
import com.speedment.ui.config.trait.HasExpandedProperty;
import com.speedment.ui.config.trait.HasNameProperty;
import com.speedment.internal.ui.property.BooleanPropertyItem;
import com.speedment.ui.config.db.BooleanPropertyItem;
import java.util.stream.Stream;
import javafx.beans.property.BooleanProperty;
import javafx.collections.ObservableList;
Expand Down
Expand Up @@ -29,8 +29,8 @@
import com.speedment.ui.config.trait.HasEnabledProperty;
import com.speedment.ui.config.trait.HasExpandedProperty;
import com.speedment.ui.config.trait.HasNameProperty;
import com.speedment.internal.ui.property.DefaultStringPropertyItem;
import com.speedment.internal.ui.property.StringPropertyItem;
import com.speedment.ui.config.db.DefaultStringPropertyItem;
import com.speedment.ui.config.db.StringPropertyItem;
import com.speedment.internal.util.document.DocumentMerger;
import java.nio.file.Path;
import java.nio.file.Paths;
Expand Down
Expand Up @@ -27,7 +27,7 @@
import com.speedment.ui.config.trait.HasEnabledProperty;
import com.speedment.ui.config.trait.HasExpandedProperty;
import com.speedment.ui.config.trait.HasNameProperty;
import com.speedment.internal.ui.property.BooleanPropertyItem;
import com.speedment.ui.config.db.BooleanPropertyItem;
import java.util.stream.Stream;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.StringProperty;
Expand Down
Expand Up @@ -19,7 +19,7 @@
import com.speedment.component.UserInterfaceComponent;
import com.speedment.event.TreeSelectionChange;
import com.speedment.exception.SpeedmentException;
import com.speedment.internal.ui.property.AbstractPropertyItem;
import com.speedment.ui.config.db.AbstractPropertyItem;
import com.speedment.internal.ui.util.Loader;
import com.speedment.internal.ui.UISession;
import com.speedment.ui.config.DocumentProperty;
Expand Down
13 changes: 13 additions & 0 deletions src/main/java/com/speedment/manager/package-info.java
@@ -0,0 +1,13 @@
/**
* The {@link com.speedment.manager.Manager} interface and its related classes
* are located in this package.
* <p>
* It is the manager that is responsible for managing entities for a particular
* table in the database. Each entity then has methods to persist and update it,
* but those methods are only delegates for the manager equivalents. Managers
* are stored in the {@link com.speedment.component.ManagerComponent}.
* <p>
* This package is part of the API. Modifications to classes here should only
* (if ever) be done in major releases.
*/
package com.speedment.manager;
8 changes: 8 additions & 0 deletions src/main/java/com/speedment/stream/action/package-info.java
@@ -0,0 +1,8 @@
/**
* The basic building blocks of the custom {@code Stream} implementation are
* located in this package.
* <p>
* This package is part of the API. Modifications to classes here should only
* (if ever) be done in major releases.
*/
package com.speedment.stream.action;
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import java.util.Optional;
import java.util.function.Consumer;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import java.util.function.Consumer;
import javafx.beans.property.BooleanProperty;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import java.util.function.Consumer;
import javafx.beans.value.ObservableValue;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import com.speedment.internal.ui.util.ObservableUtil;
import java.util.Objects;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import java.util.Objects;
import java.util.function.Consumer;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import java.util.Objects;
import static java.util.Objects.requireNonNull;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import java.util.Arrays;
import java.util.function.Consumer;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import java.util.function.Consumer;
import javafx.beans.property.IntegerProperty;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import java.util.concurrent.atomic.AtomicBoolean;
import java.util.function.Consumer;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import com.speedment.config.db.trait.HasMainInterface;
import com.speedment.ui.config.DocumentProperty;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import com.speedment.internal.ui.util.EditorsUtil;
import java.util.function.Consumer;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import java.util.function.Consumer;
import javafx.beans.property.StringProperty;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import com.speedment.internal.ui.util.EditorsUtil;
import java.util.function.Consumer;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import java.util.function.Consumer;
import javafx.beans.property.StringProperty;
Expand Down
Expand Up @@ -14,7 +14,7 @@
* License for the specific language governing permissions and limitations under
* the License.
*/
package com.speedment.internal.ui.property;
package com.speedment.ui.config.db;

import com.speedment.Speedment;
import com.speedment.config.db.mapper.TypeMapper;
Expand Down
9 changes: 9 additions & 0 deletions src/main/java/com/speedment/ui/config/db/package-info.java
@@ -0,0 +1,9 @@
/**
* The various typed {@link com.speedment.ui.config.DocumentProperty} instances
* are located in this package. These are used by the UI to manage an observable
* view of the configuration tree.
* <p>
* This package is part of the API. Modifications to classes here should only
* (if ever) be done in major releases.
*/
package com.speedment.ui.config.db;
8 changes: 8 additions & 0 deletions src/main/java/com/speedment/ui/config/package-info.java
@@ -0,0 +1,8 @@
/**
* The basic building blocks of the custom {@code Stream} implementation are
* located in this package.
* <p>
* This package is part of the API. Modifications to classes here should only
* (if ever) be done in major releases.
*/
package com.speedment.ui.config;
Expand Up @@ -19,7 +19,7 @@
import com.speedment.Speedment;
import com.speedment.config.db.trait.*;
import com.speedment.ui.config.DocumentProperty;
import com.speedment.internal.ui.property.DefaultStringPropertyItem;
import com.speedment.ui.config.db.DefaultStringPropertyItem;
import java.util.Optional;
import java.util.stream.Stream;
import javafx.beans.property.StringProperty;
Expand Down

0 comments on commit f6051c3

Please sign in to comment.