Uses of Class
com.speedment.annotation.Api

Packages that use Api

Package	Description
com.speedment	The base package of Speedment.
com.speedment.annotation	Annotations used in generated code is located in this package.
com.speedment.code	Fundamental Code Generation componenets is located in this package.
com.speedment.codegen	The main interfaces of the codegen library are located in this package.
com.speedment.codegen.model	Models for typical object-oriented language building blocks are located in this package.
com.speedment.codegen.model.modifier	Implementations of the Modifier interface that represent the modifier keywords of the java language is located in this package.
com.speedment.codegen.model.trait	Common traits used by the codegen models located in the com.speedment.codegen.lang.model package.
com.speedment.component	The Components of the Speedment platform.
com.speedment.component.brand	Interfaces related to the Brand of the application is located in this package.
com.speedment.component.connectionpool	The ConnectionPoolComponent and related classes are located in this package.
com.speedment.component.notification	Interfaces related to showing notifications in the UI is located in this package.
com.speedment.component.resultset	The ResultSetMapperComponent and related classes are located in this package.
com.speedment.config	The configuration system is located in this package.
com.speedment.config.db	Interfaces for exposing a typed database-specific view of a Document tree is located in this package.
com.speedment.config.db.mapper	Interfaces used by the database specific document types to describe mappers should be located in this package.
com.speedment.config.db.parameters	Classes that are used as parameters in the configuration model are located in this package.
com.speedment.config.db.trait	Common traits used in the typed configuration documents are located in this package.
com.speedment.db	Establishing and maintaining the database connection is handled by the classes in this package.
com.speedment.encoder	Encoders used to transform generated Speedment entities to other formats are located in this package.
com.speedment.event	The Speedment Event Bus is located in this package.
com.speedment.event.trait	Traits used in the event bus is located in this package.
com.speedment.exception	Custom Exceptions thrown by Speedment is located in this package.
com.speedment.field	Fields expose handlers for accessing columns in generated classes and are located in this package.
com.speedment.field.methods	Functional interfaces used by Fields are located in this package.
com.speedment.field.predicate	The different types of predicates generated by Fields are located in this package.
com.speedment.field.predicate.trait	Traits used in Speedment predicates are located in this package.
com.speedment.field.trait	Traits used in Speedment fields are located in this package.
com.speedment.license	Metadata used to keep track of external licenses are located in this package.
com.speedment.manager	The Manager interface and its related classes are located in this package.
com.speedment.stream	Classes concerning the custom Stream implementation used in Speedment is located in this package.
com.speedment.util	Utility classes used both internally and in generated code is located in this package.

Uses of Api in com.speedment

Classes in com.speedment with annotations of type Api

Modifier and Type	Interface and Description
interface	Entity<ENTITY> This interface contains the common methods that are the same for all entities.
interface	Speedment The Platform class acts as a generic holder of different system Components.
class	SpeedmentVersion This class holds the parameters normally held in the JAR MANIFEST.

Uses of Api in com.speedment.annotation

Classes in com.speedment.annotation with annotations of type Api

Modifier and Type	Class and Description
interface	Api Marks a Method, Type or Constructor as an API.

Uses of Api in com.speedment.code

Classes in com.speedment.code with annotations of type Api

Modifier and Type	Interface and Description
interface	JavaClassTranslator<DOC extends HasName & HasMainInterface,T extends ClassOrInterface<T>> A more specific Translator that results in a CodeGen File.
class	StandardTranslatorKey Standard implementations of the TranslatorKey interface to make it easier and more efficient to mention the most common files generated by Speedment.
interface	Translator<DOC extends Document & HasMainInterface,T> Something that can translate a Document into something else.
static interface	Translator.Builder<T> A general interface for all builder implementations used by this Translator.
static class	Translator.Phase The make process is divided into three phases; Translator.Phase.PRE_MAKE, Translator.Phase.MAKE and Translator.Phase.POST_MAKE, as specified by this enum.
interface	TranslatorConstructor<DOC extends HasMainInterface,T extends ClassOrInterface<T>> A functional interface that describes a constructor for a class that implements the Translator interface.
interface	TranslatorDecorator<DOC extends HasName & HasMainInterface,T extends ClassOrInterface<T>> This interface describes a functional reference to something that decorates a Translator before it used used.
interface	TranslatorKey<DOC extends HasMainInterface,T extends ClassOrInterface<T>> A key associated with a specific Translator.

Uses of Api in com.speedment.codegen

Classes in com.speedment.codegen with annotations of type Api

Modifier and Type	Interface and Description
interface	DependencyManager Keeps track of which dependencies have been imported and which is not included.
interface	Generator A hook to the generator that can be passed to various stages in the pipeline.
interface	Meta<A,B> Meta information about the generation process.
interface	RenderStack Represents the stack of models currently processed by the generator.
interface	Transform<F,T> Transforms must have a public constructor with no parameters so that it can be instantiated dynamically.
interface	TransformFactory Different Transform implementations can be installed in the TransformFactory to be instantiated when needed.

Uses of Api in com.speedment.codegen.model

Classes in com.speedment.codegen.model with annotations of type Api

Modifier and Type	Interface and Description
interface	Annotation A model that represents an annotation in code.
interface	AnnotationUsage A model that represents the usage of a particular annotation in code.
interface	Class A model that represents a class in code.
interface	ClassOrInterface<T extends ClassOrInterface<T>> An abstract base class to share functionality between the models Class, Enum and Interface.
interface	Constructor A model that represents a constructor in code.
interface	Enum A model that represents an enumeration in code.
interface	EnumConstant A model that represents a constant in an enumeration.
interface	Field A model that represents a field in code.
interface	File A model that represents an entire code file.
interface	Generic A model that represents the generic part of a type declaration in code.
interface	Import A model that represents the explicit import of an dependency in code.
interface	Initializer A model that represents an initializer in code.
interface	Interface A model that represents an interface in code.
interface	InterfaceField A model that represents a field of an interface in code.
interface	InterfaceMethod A model that represents a method of an interface in code.
interface	Javadoc A model that represents a block of documentation in code.
interface	JavadocTag A model that represents a specific tag in a Javadoc block.
interface	Method A model that represents a method declaration in code.
interface	Type A model that represents a type in code.
interface	Value<V> A model that represents any kind of value declared in code.

Uses of Api in com.speedment.codegen.model.modifier

Classes in com.speedment.codegen.model.modifier with annotations of type Api

Modifier and Type	Interface and Description
interface	AnnotationModifier<T extends AnnotationModifier<T>>
interface	ClassModifier<T extends ClassModifier<T>>
interface	ConstructorModifier<T extends ConstructorModifier<T>>
interface	EnumModifier<T extends EnumModifier<T>>
interface	FieldModifier<T extends FieldModifier<T>>
interface	ImportModifier<T extends ImportModifier<T>>
interface	InitalizerModifier<T extends InitalizerModifier<T>>
interface	InterfaceFieldModifier<T extends InterfaceFieldModifier<T>>
interface	InterfaceMethodModifier<T extends InterfaceMethodModifier<T>>
interface	InterfaceModifier<T extends InterfaceModifier<T>>
interface	Keyword
interface	MethodModifier<T extends MethodModifier<T>>
class	Modifier A modifier is a keyword that the programmer can put before a declaration to configure things like accessibility and lifespan.

Uses of Api in com.speedment.codegen.model.trait

Classes in com.speedment.codegen.model.trait with annotations of type Api

Modifier and Type	Interface and Description
interface	HasCall<T> Trait for code generator models that can be called.
interface	HasClasses<T extends HasClasses<T>> A trait for models that contain ClassOrInterface components.
interface	HasCode<T extends HasCode<T>> A trait for models that contains code.
interface	HasComment<T extends HasComment<T>> A trait for models that can have a comment.
interface	HasConstructors<T extends HasConstructors<T>> A trait for models that contain Constructor components.
interface	HasCopy<T extends HasCopy<T>> Trait for code generator models that can be deep-copied.
interface	HasFields<T extends HasFields<T>> A trait for models that contain Field components.
interface	HasGenerics<T extends HasGenerics<T>> A trait for models that contain Generic components.
interface	HasImplements<T extends HasImplements<T>> A trait for models that have interfaces as supertypes.
interface	HasImports<T extends HasImports<T>> A trait for models that contain Import components.
interface	HasInitalizers<T extends HasInitalizers<T>> A trait for models that contain Initializer components.
interface	HasJavadoc<T extends HasJavadoc<T>> A trait for models that contain Javadoc components.
interface	HasJavadocTags<T extends HasJavadocTags<T>> A trait for models that contain JavadocTag components.
interface	HasMethods<T extends HasMethods<T>> A trait for models that contain Method components.
interface	HasModifiers<T extends HasModifiers<T>> A trait for models that contain Modifier components.
interface	HasName<T extends HasName<T>> A trait for models that have a name.
interface	HasSupertype<T extends HasSupertype<T>> A trait for models that has a super type.
interface	HasThrows<T extends HasThrows<T>> A trait for models that can throw exceptions.
interface	HasType<T extends HasType<T>> A trait for models that has a Type.
interface	HasValue<T extends HasValue<T>> A trait for models that has a Value.

Uses of Api in com.speedment.component

Classes in com.speedment.component with annotations of type Api

Modifier and Type	Interface and Description
interface	CodeGenerationComponent This Component interface is used for Speedmens's code generation.
interface	Component A Component represents the basic functionality for a Speedment Platform Component.
interface	ComponentConstructor<C extends Component> This functional interface represents a constructor for a class implementing the Component interface.
interface	DbmsHandlerComponent This class is a pluggable factory that produces DbmsHandlers for a given Dbms.
interface	DocumentPropertyComponent Describes which implementations the Document interface to use at different places in the config tree.
interface	EntityManager An Entity Manager is be used to handle persistence for any Entity.
interface	EventComponent An event bus that is used to let Speedment plugins know when different stages of execution has been reached.
interface	ManagerComponent The ManagerComponent provides the mapping between entities and their corresponding managers.
interface	PasswordComponent
interface	PrimaryKeyFactoryComponent The PrimaryKeyFactoryComponent is responsible for generating primary keys.
interface	ProjectComponent This Component interface is used for holding the current Project that is being used by Speedment.
interface	StreamSupplierComponent This Component interface is used to obtain streams for different tables.
interface	TypeMapperComponent
interface	UserInterfaceComponent The user interface component contains a number of useful methods required to pass information between different parts of the UI.

Uses of Api in com.speedment.component.brand

Classes in com.speedment.component.brand with annotations of type Api

Modifier and Type	Interface and Description
interface	Brand A branding container.
class	Palette Container for colors that are used as part of a Brand.

Uses of Api in com.speedment.component.connectionpool

Classes in com.speedment.component.connectionpool with annotations of type Api

Modifier and Type	Interface and Description
interface	ConnectionPoolComponent This Component interface is used for holding the connection pool that is being used by Speedment.
interface	PoolableConnection

Uses of Api in com.speedment.component.notification

Classes in com.speedment.component.notification with annotations of type Api

Modifier and Type	Interface and Description
interface	Notification Container for the fields required to show a notification in the UI.

Uses of Api in com.speedment.component.resultset

Classes in com.speedment.component.resultset with annotations of type Api

Modifier and Type	Interface and Description
interface	ResultSetMapperComponent The JavaTypeMapperComponent provides a mapping from a certain DbmsType and Class to a certain JavaTypeMapping.
interface	ResultSetMapping<T>

Uses of Api in com.speedment.config

Classes in com.speedment.config with annotations of type Api

Modifier and Type	Interface and Description
interface	Document The Document is the base structure for storing configuration parameters and can be seen as a hierarchial key-value store.

Uses of Api in com.speedment.config.db

Classes in com.speedment.config.db with annotations of type Api

Modifier and Type	Interface and Description
interface	Column A typed Document that represents a column in the database.
interface	Dbms A typed Document that represents a dbms instance in the database.
interface	ForeignKey A typed Document that represents a foreign key instance in the database.
interface	ForeignKeyColumn A typed Document that represents the column referenced by a foreign key instance in the database.
interface	Index A typed Document that represents an index instance in the database.
interface	IndexColumn A typed Document that represents the column referenced by an index key instance in the database.
interface	PrimaryKeyColumn A typed Document that represents the primary key column instance in the database.
interface	Project A typed Document that represents a database project.
interface	Schema A typed Document that represents a schema instance in the database.
interface	Table A typed Document that represents a table instance in the database.

Uses of Api in com.speedment.config.db.mapper

Classes in com.speedment.config.db.mapper with annotations of type Api

Modifier and Type	Interface and Description
interface	TypeMapper<DB_TYPE,JAVA_TYPE> A type mapper contains logic for converting between the database and the java type for a field.

Uses of Api in com.speedment.config.db.parameters

Classes in com.speedment.config.db.parameters with annotations of type Api

Modifier and Type	Interface and Description
interface	DbmsType The DbmsType interface defines unique properties for different Dbms types.
class	OrderType

Uses of Api in com.speedment.config.db.trait

Classes in com.speedment.config.db.trait with annotations of type Api

Modifier and Type	Interface and Description
interface	HasAlias Trait for Document implementations that implement the HasAlias.getAlias() method.
interface	HasChildren Trait for Document implementations that has named children and therefore implements the defaultNameFor(Document) method.
interface	HasColumn Trait for Document implementations that reference another Column document and therefore has a HasColumn.findColumn() method.
interface	HasEnabled Trait for Document implementations that implement the HasEnabled.isEnabled() method.
interface	HasMainInterface A trait for documents that implement the HasMainInterface.mainInterface() method.
interface	HasMutator<T extends DocumentMutator<?>> Trait for Document implementations that implement the HasMutator.mutator() method.
interface	HasName Trait for Document implementations that implement the HasName.getName() method.
interface	HasNullable Trait for Document implementations that implement the HasNullable.isNullable() method.
interface	HasOrderType Trait for Document implementations that implement the HasOrderType.getOrderType() method.
interface	HasOrdinalPosition Trait for Document implementations that implement the HasOrdinalPosition.getOrdinalPosition() method.
interface	HasParent<PARENT extends Document> Trait for Document implementations that is not the root.

Uses of Api in com.speedment.db

Classes in com.speedment.db with annotations of type Api

Modifier and Type	Interface and Description
interface	AsynchronousQueryResult<T>
interface	ConnectionUrlGenerator A functional interface that given a certain Dbms instance can produce a connection URL.
interface	DatabaseNamingConvention Regulates how the full name of a database entity is constructed.
interface	DbmsHandler A DbmsHandler provides the interface between Speedment and an underlying Dbms.
interface	MetaResult<ENTITY>
interface	SqlFunction<T,R>
interface	SqlMetaResult<ENTITY,R extends SqlMetaResult<ENTITY,R>>
interface	SqlPredicate<T>
interface	SqlRunnable
interface	SqlSupplier<T>

Uses of Api in com.speedment.encoder

Classes in com.speedment.encoder with annotations of type Api

Modifier and Type	Interface and Description
interface	Encoder<ENTITY,R extends Encoder<ENTITY,R,OUTPUT_TYPE>,OUTPUT_TYPE> The Encoder can be used to format an Entity into any kind of strings.
class	JsonEncoder<ENTITY>

Uses of Api in com.speedment.event

Classes in com.speedment.event with annotations of type Api

Modifier and Type	Class and Description
class	AfterGenerate
class	BeforeGenerate
class	DefaultEvent
interface	Event
class	ProjectLoaded
class	TreeSelectionChange
class	UIEvent Event that is created when the User Interface is starting.
class	UiStarting Event that is created when the User Interface is starting.

Uses of Api in com.speedment.event.trait

Classes in com.speedment.event.trait with annotations of type Api

Modifier and Type	Interface and Description
interface	GeneratorEvent
interface	ProjectEvent

Uses of Api in com.speedment.exception

Classes in com.speedment.exception with annotations of type Api

Modifier and Type	Class and Description
class	SpeedmentException SpeedmentException is the superclass of those exceptions that can be thrown during the normal operation of the Speedment framework.

Uses of Api in com.speedment.field

Classes in com.speedment.field with annotations of type Api

Modifier and Type	Interface and Description
interface	ComparableField<ENTITY,D,V extends Comparable<? super V>> A field that implements the ReferenceFieldTrait and ComparableFieldTrait.
interface	ComparableForeignKeyField<ENTITY,D,V extends Comparable<? super V>,FK> A field that represents a value that implements ReferenceFieldTrait, ComparableFieldTrait and {ReferenceForeignKeyFieldTrait}.
interface	FieldIdentifier<ENTITY> Identifies a particular field in an entity.
class	Inclusion Determines if a range of resuls should be start and/or end-inclusive.
interface	ReferenceField<ENTITY,D,V> A field that implements the ReferenceFieldTrait.
interface	ReferenceForeignKeyField<ENTITY,D,V,FK_ENTITY> A field that represents a value that implements the ReferenceFieldTrait and the {ReferenceForeignKeyFieldTrait}.
interface	StringField<ENTITY,D> A field that implements the ReferenceFieldTrait, the ComparableFieldTrait and the StringFieldTrait.
interface	StringForeignKeyField<ENTITY,D,FK_ENTITY> A field that implements the ReferenceFieldTrait, the ComparableFieldTrait, the StringFieldTrait and the {ReferenceForeignKeyFieldTrait}.

Uses of Api in com.speedment.field.methods

Classes in com.speedment.field.methods with annotations of type Api

Modifier and Type	Interface and Description
interface	FieldSetter<ENTITY,V> Represents a set-operation with all the metadata contained.
interface	Finder<ENTITY,FK_ENTITY> A short-cut functional reference to the findXXX() method for a particular field in an entity.
interface	Getter<ENTITY,V> A short-cut functional reference to the getXXX() method for a particular field in an entity.
interface	Setter<ENTITY,V> A short-cut functional reference to the setXXX(value) method for a particular field in an entity.
interface	Streamer<ENTITY,FK_ENTITY> A short-cut functional reference to the streaming findXXXs() method for a particular field referencing this entity.

Uses of Api in com.speedment.field.predicate

Classes in com.speedment.field.predicate with annotations of type Api

Modifier and Type	Interface and Description
interface	ComparableSpeedmentPredicate<T,D,V extends Comparable<? super V>> A SpeedmentPredicate where the value implements Comparable.
class	PredicateType The predicate types that exists in Speedment.
interface	SpeedmentPredicate<ENTITY,D,V> The base interface for all predicates generated by Speedment entity fields.
interface	StringSpeedmentPredicate<T,D> A SpeedmentPredicate where the value are Strings.

Uses of Api in com.speedment.field.predicate.trait

Classes in com.speedment.field.predicate.trait with annotations of type Api

Modifier and Type	Interface and Description
interface	HasEffectivePredicateType A trait for predicates the implement the HasEffectivePredicateType.getEffectivePredicateType() method.
interface	HasFieldTrait A trait for predicates the implement the HasFieldTrait.getField() method.
interface	HasGetter<ENTITY,V> A trait for predicates the implement the HasGetter.getter() method.
interface	HasNegated A trait for predicates the implement the HasNegated.isNegated() method.
interface	HasPredicateType A trait for predicates the implement the HasPredicateType.getPredicateType() method.
interface	HasReferenceFieldTrait<ENTITY,D,V> A trait for predicates the implement the HasReferenceFieldTrait.getReferenceField() method.

Uses of Api in com.speedment.field.trait

Classes in com.speedment.field.trait with annotations of type Api

Modifier and Type	Interface and Description
interface	ComparableFieldTrait<ENTITY,D,V extends Comparable<? super V>> A representation of an Entity field that is a reference type (e.g.
interface	FieldTrait A trait that every field implements.
interface	ReferenceFieldTrait<ENTITY,D,V> A representation of an Entity field that is a reference type (eg Integer and not int).
interface	ReferenceForeignKeyFieldTrait<ENTITY,D,FK_ENTITY> A representation of an Entity field that is a reference type (eg Integer and not int) and that is a foreign key to some other field.
interface	StringFieldTrait<ENTITY,D> A representation of an Entity field that is a String type.

Uses of Api in com.speedment.license

Classes in com.speedment.license with annotations of type Api

Modifier and Type	Interface and Description
interface	License Trait used to separate open source from commercial components.
interface	Software Represents a third-party dependency.

Uses of Api in com.speedment.manager

Classes in com.speedment.manager with annotations of type Api

Modifier and Type	Interface and Description
interface	Manager<ENTITY> A Manager is responsible for abstracting away an Entity's data source.

Uses of Api in com.speedment.stream

Classes in com.speedment.stream with annotations of type Api

Modifier and Type	Class and Description
class	MapStream<K,V> A java Stream wrapper that stream over Key-Value pairs.
interface	StreamDecorator Decorator that is applied to a various part of the custom streams of Speedment before execution.

Uses of Api in com.speedment.util

Classes in com.speedment.util with annotations of type Api

Modifier and Type	Class and Description
class	CollectorUtil Utility methods for collecting Speedment streams in various ways.
class	NullUtil
class	StaticClassUtil Support class for classes that only contains static methods and fields.
class	StreamComposition Utility methods for making sure composed streams are closed properly.