getContent()
{
diff --git a/core/src/main/java/org/marketcetera/marketdata/UriScheme.java b/core/src/main/java/org/marketcetera/marketdata/UriScheme.java
index 49a0cd46b6..f24f90797b 100644
--- a/core/src/main/java/org/marketcetera/marketdata/UriScheme.java
+++ b/core/src/main/java/org/marketcetera/marketdata/UriScheme.java
@@ -114,7 +114,6 @@ public boolean equals(Object obj)
* @param inHostname a String value
* @param inPort an int value
* @return a String value containing a conforming URI
- * @throws URISyntaxException if the given URI is not syntactically valid
* @throws IllegalArgumentException if the host or port is not valid
*/
public String composeUriString(String inHostname,
diff --git a/core/src/main/java/org/marketcetera/metrics/IsotopeService.java b/core/src/main/java/org/marketcetera/metrics/IsotopeService.java
index 3e7c869e10..56dd3cf252 100644
--- a/core/src/main/java/org/marketcetera/metrics/IsotopeService.java
+++ b/core/src/main/java/org/marketcetera/metrics/IsotopeService.java
@@ -193,7 +193,7 @@ public int getFixIsotopeTag()
/**
* Sets the fixIsotopeTag value.
*
- * @param an int value
+ * @param inFixIsotopeTag an int value
*/
public void setFixIsotopeTag(int inFixIsotopeTag)
{
diff --git a/core/src/main/java/org/marketcetera/metrics/ThreadedMetric.java b/core/src/main/java/org/marketcetera/metrics/ThreadedMetric.java
index 0c3e954038..8c870e11d7 100644
--- a/core/src/main/java/org/marketcetera/metrics/ThreadedMetric.java
+++ b/core/src/main/java/org/marketcetera/metrics/ThreadedMetric.java
@@ -19,13 +19,13 @@
*
* The class captures the metrics on a per thread basis. The captured metrics
* include the time taken by the system between certain checkpoints in code and
- * the total number of times the system performed certain computation.
+ * the total number of times the system performed certain computation.
*
* The computed data is dumped into a per-thread csv file in the jvm's
* {@link java.io.File#createTempFile(String, String)} temporary} directory
* location.
- *
- *
Usage
+ *
+ * Usage
* The code that needs to be instrumented should be modified to invoke
* ThreadedMetric as follows.
*
@@ -78,7 +78,7 @@
* thread local variables to keep track of iterations, you might get
* non-intuitive results.
*
- * Output
+ * Output
*
* The class will dump the collected metrics as a CSV file, in the temp
* directory location with the name
@@ -123,11 +123,11 @@
*
* Under certain circumstances, the rows may contain extra columns at the end.
* These extra columns either contain any extra data that was supplied to any of
- * the checkpoint calls: begin(), event() & end() for the
+ * the checkpoint calls: begin(), event() & end() for the
* iteration that the row represents. OR they may contain extra checkpoint
* time deltas resulting from event() invocations within a loop.
*
- * Configuration & Management
+ * Configuration & Management
*
* The instrumentation is disabled by default. It can be turned on via JMX
* or via a properties file placed in the classpath. For more information
@@ -158,7 +158,7 @@ public static void begin(Object ... inParams) {
*
* @param inIdentifier the name of the milestone. The milestone name
* should be different from the reserved identifier names,
- * {@link #BEGIN_IDENTIFIER} & {@link #END_IDENTIFIER}.
+ * {@link #BEGIN_IDENTIFIER} & {@link #END_IDENTIFIER}.
* @param inParams any extra information to include in the summary.
*/
public static void event(String inIdentifier, Object... inParams) {
diff --git a/core/src/main/java/org/marketcetera/module/ModuleDescriptor.java b/core/src/main/java/org/marketcetera/module/ModuleDescriptor.java
index 814346687d..d86049226d 100644
--- a/core/src/main/java/org/marketcetera/module/ModuleDescriptor.java
+++ b/core/src/main/java/org/marketcetera/module/ModuleDescriptor.java
@@ -18,7 +18,7 @@ public class ModuleDescriptor
/**
* Get the parameters value.
*
- * @return a List value
+ * @return a List<Object> value
*/
public List getParameters()
{
@@ -27,7 +27,7 @@ public List getParameters()
/**
* Sets the parameters value.
*
- * @param inParameters a List value
+ * @param inParameters a List<Object> value
*/
public void setParameters(List inParameters)
{
diff --git a/core/src/main/java/org/marketcetera/module/ModuleFactory.java b/core/src/main/java/org/marketcetera/module/ModuleFactory.java
index 79d6a90161..a3bf2dd6c1 100644
--- a/core/src/main/java/org/marketcetera/module/ModuleFactory.java
+++ b/core/src/main/java/org/marketcetera/module/ModuleFactory.java
@@ -119,8 +119,7 @@ public final boolean isAutoInstantiate() {
/**
* Returns the name of the module provider. A module
- * provider URI has the following form.metc:provType:providerName
+ * provider URI has the following form: metc:provType:providerName
*
* @return the provider's URN
*/
diff --git a/core/src/main/java/org/marketcetera/module/ModuleManagerMXBean.java b/core/src/main/java/org/marketcetera/module/ModuleManagerMXBean.java
index 35a651d18f..18a8e26367 100644
--- a/core/src/main/java/org/marketcetera/module/ModuleManagerMXBean.java
+++ b/core/src/main/java/org/marketcetera/module/ModuleManagerMXBean.java
@@ -43,23 +43,23 @@
* when invoking the create module instance API.
*
*
- * Example 1:
- *
- * Parameter Types:ModuleURN, URL, String, BigDecimal
- * Parameter Value:
- * "metc:surface:color:red,http://red.com,username,12.43"
- *
- *
- * Example 2:
- *
- * Parameter Types:File, boolean, double, BigInteger
- * Parameter Value:"c:\\mydir,true,345.643,83723849"
- *
+ * Example 1:
+ *
+ * Parameter Types:ModuleURN, URL, String, BigDecimal
+ * Parameter Value:"metc:surface:color:red,http://red.com,username,12.43"
+ *
+ *
+ * Example 2:
+ *
+ * Parameter Types:File, boolean, double, BigInteger
+ * Parameter Value:"c:\\mydir,true,345.643,83723849"
+ *
+ *
*
*
- * Create Data Flows
+ * Create Data Flows
* This parameter syntax applies to the first parameter of APIs
- * {@link #createDataFlow(String)} &
+ * {@link #createDataFlow(String)} &
* {@link #createDataFlow(String, boolean)}.
*
* The API accepts a series of data requests. Each data request consists of
@@ -80,34 +80,34 @@
* Here are some examples of strings that can be used when setting up data
* flows.
*
- * Example 1.
- *
- * "metc:mdata;symbol=ibm^metc:strategy::vegas^metc:sink"Sets up a data flow between any market data module that generates
+ * Example 1.
+ *
+ * "metc:mdata;symbol=ibm^metc:strategy::vegas^metc:sink"Sets up a data flow between any market data module that generates
* market data for symbol 'ibm', pipes that data to a strategy named
* 'vegas' and pipes its output to the sink module.
- *
- * Example 2.
- *
- * "metc:mdata:opentick;symbol=java^metc:strategy::charity^metc:server"Sets up a data flow between opentick market data module, that
- * generates market data for symbol 'java', pipes that data to a
- * strategy called 'charity' and pipes the trades generated by it to
- * the system client module that sends it to the server.
- *
- * Example 3.
- *
- * "metc:mdata;symbol=aapl,goog^metc:cep:esper;select * from Bid^metc:strategy::buy;12^^32^^43"Sets up a data flow between any market data module that generates
- * data for symbols, aapl & goog, pipes that data into the esper module, that
- * runs the cep query 'select * from Bid' and pipes its output to
- * a strategy module 'buy' that accepts a string parameter '12^32^43'.
- *
- *
+ *
+ *
+ * Example 2.
+ *
+ * "metc:mdata:opentick;symbol=java^metc:strategy::charity^metc:server"Sets up a data flow between opentick market data module, that
+ * generates market data for symbol 'java', pipes that data to a
+ * strategy called 'charity' and pipes the trades generated by it to
+ * the system client module that sends it to the server.
+ *
+ *
+ * Example 3.
+ *
+ * "metc:mdata;symbol=aapl,goog^metc:cep:esper;select * from Bid^metc:strategy::buy;12^^32^^43"Sets up a data flow between any market data module that generates
+ * data for symbols, aapl & goog, pipes that data into the esper module, that
+ * runs the cep query 'select * from Bid' and pipes its output to
+ * a strategy module 'buy' that accepts a string parameter '12^32^43'.
+ *
+ *
*
*
- *
- *
* @author anshul@marketcetera.com
* @version $Id$
* @since 1.0.0
diff --git a/core/src/main/java/org/marketcetera/module/ModuleState.java b/core/src/main/java/org/marketcetera/module/ModuleState.java
index 8c186802a5..1cc9dc31cf 100644
--- a/core/src/main/java/org/marketcetera/module/ModuleState.java
+++ b/core/src/main/java/org/marketcetera/module/ModuleState.java
@@ -24,11 +24,11 @@
* | start()
* |
* v
- * ,------> {@link #STARTING}
+ * ,------> {@link #STARTING}
* / |\ ^
* | | \ \ start()
* | | v \ delete()
- * | | {@link #START_FAILED}--------->.
+ * | | {@link #START_FAILED}--------->.
* | | |
* | v |
* | {@link #STARTED} |
@@ -41,13 +41,13 @@
* | |\ ^ |
* | | \ \ stop() |
* | | v \ delete() |
- * | | {@link #STOP_FAILED}---------->|
+ * | | {@link #STOP_FAILED}---------->|
* | | |
* \ v |
* '------- {@link #STOPPED} |
* | |
* | delete() |
- * |<--------------------------------'
+ * |<--------------------------------'
* v
* O
*
@@ -57,8 +57,9 @@
* various module framework operations can be invoked on a module. If
* a module operation is invoked while it's not in one of the states for
* that operation in the table below, the operation will fail.
- *
- *
+ *
+ *
+ * Module State Capabilities
* Module Operation Module State delete {@link #CREATED}, {@link #START_FAILED}, {@link #STOPPED}
* stop {@link #STARTED}, {@link #STOP_FAILED}
diff --git a/core/src/main/java/org/marketcetera/module/ModuleURN.java b/core/src/main/java/org/marketcetera/module/ModuleURN.java
index 6adc22d710..04e020a469 100644
--- a/core/src/main/java/org/marketcetera/module/ModuleURN.java
+++ b/core/src/main/java/org/marketcetera/module/ModuleURN.java
@@ -19,9 +19,9 @@
* of the URN evaluate as equal.
*
* The URNs have the following format
- * metc:provType:provider:instance
- *where :
*
* metc : The URN prefix metc indicating a marketcetera URNinstance-name.attribute-name=attribute-value.
* Default attribute values, that apply to all instances can be specified as
- * .attribute-name=attribute-value.attribute-name=attribute-value.
*
* For factory attributes, "instance-name." is excluded from
* the property name, ie. the attribute value is specified as
diff --git a/core/src/main/java/org/marketcetera/module/SinkModule.java b/core/src/main/java/org/marketcetera/module/SinkModule.java
index 8988935180..c347263c7c 100644
--- a/core/src/main/java/org/marketcetera/module/SinkModule.java
+++ b/core/src/main/java/org/marketcetera/module/SinkModule.java
@@ -38,6 +38,7 @@
*
* Module Features
*
+ * Sink Module Capabilities
* Capabilities DataReceiver Stops data flows No Start Operation Does nothing
* The factory has the following characteristics.
*
+ * Sink Module Factory Capabilities
* Provider URN: metc:sink:systemCardinality: Singleton InstanceURN: metc:sink:system:single
- * {@link org.marketcetera.module.ModuleURN URNs} are used to uniquely identify module types & module
+ * {@link org.marketcetera.module.ModuleURN URNs} are used to uniquely identify module types & module
* instances.
*
*
@@ -152,11 +152,11 @@
*
* Data of any type can be used for all these three usages. However, modules are
* strongly recommended to accept strings, in addition to any specific types they need,
- * for usages 1 & 2 above.
+ * for usages 1 & 2 above.
*
*
* Module Framework API is available via an MXBean through JMX. And
- * that API only supports string parameters for usages 1 & 2 above. The module
+ * that API only supports string parameters for usages 1 & 2 above. The module
* framework automatically converts string parameters to actual java types,
* for a limited set of types listed below, for usage 1 above.
* To the extent modules support string
@@ -278,7 +278,7 @@
* A module can acquire the capability to initiate a data flow by implementing
* {@link org.marketcetera.module.DataFlowRequester}. It can then create and
* cancel data flows via {@link org.marketcetera.module.DataFlowSupport}.
- * A module can request & cancel data flows when it's in the
+ * A module can request & cancel data flows when it's in the
* {@link org.marketcetera.module.ModuleState#isStarted() started} state.
* It's expected that a module will typically create data flows when it's started
* from within its {@link org.marketcetera.module.Module#preStart()} method.
@@ -312,7 +312,7 @@
*
* Do note that if the module or the module factory implements
* {@link javax.management.DynamicMBean} make sure that the types used
- * for various bean attributes & operations are limited to standard java
+ * for various bean attributes & operations are limited to standard java
* types. Otherwise, tools like jconsole will not be able to display
* information from those beans.
*
@@ -325,7 +325,7 @@
*
* The module framework functions are exported via
* {@link org.marketcetera.module.ModuleManagerMXBean}. All of its operations
- * accept parameters of primitive & string types, so that they can be easily
+ * accept parameters of primitive & string types, so that they can be easily
* invoked by widely available jmx clients like jconsole. Operations to
* create module instances and data flows support special string syntax as
* these operations accept complex parameters. Look at the bean's class
@@ -417,6 +417,7 @@
* sub-classes for examples.
*
*
+ * Describes the ModuleFactory
* Provider URN: The provider URN Cardinality: If the factory creates a singleton module
* instance or if it can create module instances.
+ * Describes the Module
* Capabilities If the module can emit, receive data and if it
* can request data flows. DataFlow Request Parameters The type of parameters that
diff --git a/core/src/main/java/org/marketcetera/persist/CollectionPageResponse.java b/core/src/main/java/org/marketcetera/persist/CollectionPageResponse.java
index a7f2b8d68f..a2a829153a 100644
--- a/core/src/main/java/org/marketcetera/persist/CollectionPageResponse.java
+++ b/core/src/main/java/org/marketcetera/persist/CollectionPageResponse.java
@@ -26,7 +26,7 @@ public CollectionPageResponse() {}
/**
* Create a new CollectionPageResponse instance.
*
- * @param inPage a Page<Clazz>: value
+ * @param inPage a Page<Clazz> value
*/
public CollectionPageResponse(Page inPage)
{
diff --git a/core/src/main/java/org/marketcetera/persist/NDEntityBase.java b/core/src/main/java/org/marketcetera/persist/NDEntityBase.java
index 430cc07558..67ff18b5b1 100644
--- a/core/src/main/java/org/marketcetera/persist/NDEntityBase.java
+++ b/core/src/main/java/org/marketcetera/persist/NDEntityBase.java
@@ -22,20 +22,6 @@
*
* Supporting query classes are also provided to easily add
* query support for the subclasses.
- *
- *
- * {@link org.marketcetera.persist.SingleNDEntityQuery} provides
- * support for queries that fetch single instance given the entity
- * name. Note that this assumes the names of the entities are unique
- * amongst all its instances. To ensure that, subclasses that make
- * use of this feature should declare a unique constraint on the
- * name attribute.
- *
- * {@link org.marketcetera.persist.MultiNDQuery} provides support
- * for queries that fetch multiple instances of subclasses of this
- * class. The query class provides filters to filter the query
- * results by name and description filters. It also provides
- * orders to order the results by name or description.
*
*/
@MappedSuperclass
diff --git a/core/src/main/java/org/marketcetera/persist/TransactionModuleFactory.java b/core/src/main/java/org/marketcetera/persist/TransactionModuleFactory.java
index 720e8467f6..8cd6edac13 100644
--- a/core/src/main/java/org/marketcetera/persist/TransactionModuleFactory.java
+++ b/core/src/main/java/org/marketcetera/persist/TransactionModuleFactory.java
@@ -12,6 +12,7 @@
*
* The factory has the following characteristics.
*
+ * Transaction Module Factory capabilities
* Provider URN: metc:core:transactionCardinality: Singleton Instance URN: metc:core:transaction:single
- This package provides basic building blocks for creating objects that can be stored
- within an rdbms. Base classes are provided to represent entities and to query them.
- Facilities are also provided to transparently save and query entities across a remoting
- API, like JMX or JMS.
-
-
- The persistence infrastructure has two layers.
-
- The Services layer abstracts all persistence operations into a small set of internal
- methods that can easily be remoted if needed. This layer also provides transaction
- boundaries and JPA entity manager instances for the entities layer above it. The
- interfaces provided by this layer are only meant to be used by the Entities layer.
- The Entities layer runs on top of services layer and provides abstractions that
- are meant to be subclassed by anyone wanting to author persistent entities and
- provide simple services to save, update, delete and query them. Clients of persistence
- infrastructure should use the API provided by the Entities layer.
-
- The Entities Layer is meant to be used by the clients of this system, whereas
- the Services layer is a part of the implementation.
-
-Services Layer
- All persistence operations are abstracted into method calls on the
- {@link org.marketcetera.persist.EntityRemoteServices}
- interface. Only one concrete implementation of this interface,
- {@link org.marketcetera.persist.EntityRemoteServer} is provided. It implements these
- methods by invoking the local JPA EntityManagerFactory instance.
-
-
- The intent is that, in the future, other implementations of the
- {@link org.marketcetera.persist.EntityRemoteServices} can be supplied that can
- transparently remote (via JMS, JMX, RMI or any other remoting infrastructure)
- persistence operations across JVMs from a client-side VM to the server-side VM that
- has an EntityRemoteServer instance configured to carry out all the persistence
- operations on a local database.
-
-
- This layer is configured via spring. The spring configuration is responsible
- for configuring a database connection pool, an entity manager factory and injecting
- that factory into the EntityRemoteServer instance.
-
-
- Another piece of the infrastructure that is configured via spring is
- {@link org.marketcetera.persist.JPAVendor} implementation.
- {@link org.marketcetera.persist.JPAVendor} abstracts out our dependency on
- vendor specific code. JPA doesn't seem to cover all our usage scenarios,
- like blob/clob initialization. This class is used to provide a vendor neutral
- mechanism to carry out persistence operations that are not covered via JPA.
- This functionality is exposed to the clients of persistence layer via the
- {@link org.marketcetera.persist.VendorUtils} class.
-
-
-Entities Layer
-
- The entities layer provides base classes for Entities and single / multi instance
- queries to fetch them.
-
-
-Entities
-
- Any new persistent entity can either extend
- {@link org.marketcetera.persist.EntityBase} or
- {@link org.marketcetera.persist.NDEntityBase},
- if it has name and description. Make sure to add appropriate JPA annotations to mark it
- as a persistent entity. Do annotate any of its non-persitent attributes with a Transient
- annotation.
-
- Views
-
- Entities can have attributes that are lazy loaded. These attributes are the ones
- that are costly to fetch. Examples include, attributes that represent the entity's
- relationship with other entities etc.
- To facilitate choice between loading these attributes or not, summary view interfaces
- like {@link org.marketcetera.persist.SummaryEntityBase} and
- {@link org.marketcetera.persist.SummaryNDEntityBase} are provided. These interfaces
- do not contain any setters for the attributes. Its expected, that the sub entites
- will create sub-interfaces that extend from these summary interfaces and add all
- other non-lazy loaded attributes to it.
-
-
-Queries
-
- Two types of queries are supported.
-
-
- Queries that fetch single instances: {@link org.marketcetera.persist.SingleEntityQuery}
- Queries that fetch multiple entity instances:{@link org.marketcetera.persist.MultipleEntityQuery}
-
-
- Queries provide the option to either load the summary view of the entity or
- its full view. Loading the full view is more expensive
-
-
-SingleEntityQuery
-
- These queries fetch a single instance of the entity. Examples include fetching
- the entity by ID or by its name, etc.
-
-
-MultipleEntityQuery
-
- These queries fetch multiple instances of the entity. These queries support
- filtering, ordering and paging of the results. For Entities that extend
- {@link org.marketcetera.persist.NDEntityBase},
- a base class {@link org.marketcetera.persist.MultiNDQuery} is provided for others
- to extend. The subclass implements the filtering & ordering behavior for
- entity name and description.
-
-
- MultiQueries have filter properties on them to filter their results. By default
- these filters are not set. A client of these queries can set these filters to
- apply them to the results. See {@link org.marketcetera.persist.MultiNDQuery#getNameFilter()}
- for example.
-
-
- MultiQueries can have an ordering applied to their results. See
- {@link org.marketcetera.persist.MultipleEntityQuery#getEntityOrder()}.
-
-
- MultiQueries can specify the
- {@link org.marketcetera.persist.MultipleEntityQuery#getFirstResult() starting}
- position of the results and the
- {@link org.marketcetera.persist.MultipleEntityQuery#getMaxResult() maximum} number of results
- to return back.
-
-Development Notes
-
- Once the entities, that need to be persisted, and the relationships between them have
- been figured out, we can start authoring classes for them using the persistence
- infrastructure. Base classes are available for basic entity operations and unit testing.
- See org.marketcetera.persist.example package in the unit test sources for a
- sample implementation
-
-Entities
-
- Each entity can either extend {@link org.marketcetera.persist.EntityBase} or
- {@link org.marketcetera.persist.NDEntityBase} based on whether
- the entity has name and description attributes. If the entity has relationships or lazy loaded
- attributes, its recommended that a Summary View be defined for the entity that doesn't
- include any relationship or lazy-loaded attributes. The summary view can extend either of
- {@link org.marketcetera.persist.SummaryEntityBase} or
- {@link org.marketcetera.persist.SummaryNDEntityBase} depending on whether the entity
- has name and description attributes.
-
-
- Each entity subclass adds appropriate attributes to the class definition. The attributes can
- be annotated with JPA annotations if the default behavior is not sufficient.
-
-
- Each entity subclass can expose operations to save and delete the entity that in turn invoke
- the protected operations provided in the super classes. The entity can also define their own
- operations that use these operations. See User class in unit tests for examples
- of such operations.
-
-
- Relationships between the entities have a side that owns the relationship. Make sure that
- the operations to modify the relationship are only exposed on the entity that owns the
- relationship. For example, Group owns the relationship between User
- and Group
-
-Queries
-
- Each entity has a single instance query and a multi instance query. Base classes are provided
- for both kinds of queries. See the org.marketcetera.persist.example package for how
- to extend and use these queries.
-
-
- Typically, single instance queries will be fairly simple. For multi instance queries you may
- want to declare additional filters, orders and operations.
-
-Validation
-
- Entities should be validated prior to save to ensure that all the attributes
- have valid values. See {@link org.marketcetera.persist.NDEntityBase#validate()}
- for an example on how to do it. Be sure to add both
- {@link javax.persistence.PrePersist} and {@link javax.persistence.PreUpdate} to
- ensure that validation happens during insert as well as update
-
-
- The current database can only save a subset of characters supported by java.
- Hence all the strings that are being persisted should be validated to ensure that
- they comply with the character set supported by the database.
- {@link org.marketcetera.persist.VendorUtils#validateText(CharSequence)} should be invoked
- to validate all the string query parameters, & entity attributes.
-
- Do ensure that all string attributes of the entity being saved are validated
- prior to save. Currently, only the name attribute of
- {@link org.marketcetera.persist.NDEntityBase} is validated. Any other string attributes
- in the entity (including description) should be validated to only contain supported
- characters.
-
-
- All the string parameters to the query are validated to only supported characters
- during query execution with {@link org.marketcetera.persist.QueryBase}.
- Hence no special validation is required during query execution. However, if you
- author queries that do not make use QueryBase, make sure that all
- string parameters to the query are validated.
-
-Unit Testing
-
- Since the extent of compile-time checking is limited. Base classes are available to extensively
- test the entities and their queries. The design pattern is to extend a suitable base class for
- testing an entity. It can be either of EntityTestBase or NDEntityTestBase
- depending on whether the entity has name and description attributes.
-
-
- You'd need to implement all the abstract methods to be able to compile the unit tests. You'd want
- to over-ride certain methods for any additional attributes that have been added to the entity.
- See UserTest for example.
-
-
- A base class, ManyToManyTestBase is also provided to test many to many relationships
- between entities. See UserGroupTest for an example
-
-
- The unit test base classes only provide unit tests to exercise the functionality provided
- by the infrastructure. You'd want to add unit tests to exercise any features that have been
- built on top of the features provided by the infrastructure.
- See UserTest for an example.
-
-Configuration
-
- The global persistence layer is configured via spring configuration. The entities have
- to provide a persistence.xml, in the META-INF sub-directory of the jar they
- are contained in, to enable their persistence.
-
-Spring Configuration
-
- Here's a sample spring configuration snippet:
-
- The first bean configures a connection pool data source
- The second one configures a JPA entity manager factory, supplying it the connection
- pool data source.
- The last bean configures the EntityRemoteServer supplying it the entity manager
- factory. Notice that it depends on a jpaVendor bean. The only
- {@link org.marketcetera.persist.JPAVendor} implementation currently available
- is {@link org.marketcetera.persist.HibernateVendor}.
-
-
-
-{@code
-...
-
-
-
-
-
-
-...
-}
-
-
- Do note that the dependency on the mysql jdbc connector, apache dbcp connection pooling &
- spring entity manager bean configuration is only within the spring configuration. The java
- code has no dependency on these specific implementations.
-
-
- Several properties can be configured for the MySQL jdbc connector and the apache
- dbcp connection pool. Configuration details can be found at the following locations.
-
-
-persistence.xml Configuration
-
- The persistence.xml schema can be found here .
- Good notes on configuring persistence.xml can be found in hibernate documentation
- here
- The persistence.xml file should be present in the META-INF subdirectory of jar that contains
- the classes for the entities being persisted.
-
-
- Here's an example persistence.xml file, used to persist entities using hibernate's JPA implementation.
-
-
-{@code
-
-
- org.hibernate.ejb.HibernatePersistence
-
-
-
-
-}
-
-
- Do note that several hibernate configuration properties can be supplied. Details on the kinds of
- properties that can be specified can be found
- here .
- Do note that an jdbc connection / data source properties should not be specified here as they
- are specified via spring configuration.
-
-Design Details
-
- This section has details on design and implementation of the persistence
- infrastructure.
-
-Code Paths
-
- This section has sample code paths for certain key interesting code paths in the persistence system.
-
-Save Operation
-
- This section documents the sequence of API invocations that happen when saving an entity.
- The sequence is a similar to what happens when the delete operation is invoked.
-
-
- The methods with the suffix Remote are meant to be invoked by the client
- facing API to invoke a persistence operation. These method invocations endup invoking
- the corresponding operation with Local suffix on the entity within the
- JVM that has access to the database and is configured with appropriate JPA
- EntityManager to interact with the database.
-
-
- {@link org.marketcetera.persist.EntityBase#saveRemote(PersistContext)}
- |
- |-{@link org.marketcetera.persist.EntityBase#createSaveResult()}
- |
- |-{@link org.marketcetera.persist.EntityRemoteServices#save(EntityBase,PersistContext)}
- | | (Remoting)
- | |
- | '-{@link org.marketcetera.persist.EntityRemoteServices#execute(Transaction,PersistContext)}
- | | (Transaction Envelope)
- | |
- | '-{@link org.marketcetera.persist.EntityBase#saveLocal(EntityManager,PersistContext)}
- | |
- | |-{@link org.marketcetera.persist.EntityBase#postSaveLocal(EntityManager,EntityBase,PersistContext)}
- | | (Can be over-ridden to carry out custom stuff)
- | |
- | '-{@link org.marketcetera.persist.EntityBase#createSaveResult()}
- |
- '-{@link org.marketcetera.persist.EntityBase#applyRemote(SaveResult)}
-
-Multi Query Execution
-
- This section documents the sequence of API invocations that happen when running a multi
- instance query.
-
-
-
- {@link org.marketcetera.persist.MultipleEntityQuery#fetchRemote(MultiQueryProcessor)}
- |
- '-{@link org.marketcetera.persist.QueryBase#executeRemote(QueryProcessor)}
- |
- '-{@link org.marketcetera.persist.QueryBase#executeRemoteMultiple(List)}
- |
- '-{@link org.marketcetera.persist.EntityRemoteServices#execute(QueryBase,List)}
- | (Remoting)
- |
- '-{@link org.marketcetera.persist.EntityRemoteServices#execute(Transaction,PersistContext)}
- | (Transaction Envelope)
- |
- '-{@link org.marketcetera.persist.QueryBase#executeLocal(EntityManager,List)}
- |
- |-{@link org.marketcetera.persist.QueryBase#createQuery(EntityManager,QueryProcessor)}
- | | (creates query string customized by query processor)
- | |
- | |-{@link org.marketcetera.persist.QueryProcessor#preGenerate(StringBuilder,QueryBase)}
- | |
- | |-{@link org.marketcetera.persist.QueryProcessor#needsFetchJoins()}
- | |
- | |-{@link org.marketcetera.persist.QueryProcessor#needsOrderBy()}
- | |
- | |-{@link org.marketcetera.persist.QueryProcessor#postGenerate(StringBuilder)}
- | |
- | '-{@link org.marketcetera.persist.MultipleEntityQuery#preSetParameters(Query)}
- |
- '-{@link org.marketcetera.persist.QueryProcessor#process(EntityManager,Query)}
- (processes the query to generate results)
-
-
\ No newline at end of file
diff --git a/core/src/main/java/org/marketcetera/pool/impl/ExecutorServiceProviderImpl.java b/core/src/main/java/org/marketcetera/pool/impl/ExecutorServiceProviderImpl.java
index 95aa2c1838..b9fe48f867 100644
--- a/core/src/main/java/org/marketcetera/pool/impl/ExecutorServiceProviderImpl.java
+++ b/core/src/main/java/org/marketcetera/pool/impl/ExecutorServiceProviderImpl.java
@@ -68,7 +68,7 @@ public int getMaxPoolSize()
/**
* Sets the maxPoolSize value.
*
- * @param an int value
+ * @param inMaxPoolSize an int value
*/
public void setMaxPoolSize(int inMaxPoolSize)
{
@@ -86,7 +86,7 @@ public boolean getAllowCoreThreadTimeOut()
/**
* Sets the allowCoreThreadTimeOut value.
*
- * @param a boolean value
+ * @param inAllowCoreThreadTimeOut a boolean value
*/
public void setAllowCoreThreadTimeOut(boolean inAllowCoreThreadTimeOut)
{
@@ -104,7 +104,7 @@ public int getCorePoolSize()
/**
* Sets the corePoolSize value.
*
- * @param an int value
+ * @param inCorePoolSize an int value
*/
public void setCorePoolSize(int inCorePoolSize)
{
@@ -122,7 +122,7 @@ public int getKeepAliveTime()
/**
* Sets the keepAliveTime value.
*
- * @param an int value
+ * @param inKeepAliveTime an int value
*/
public void setKeepAliveTime(int inKeepAliveTime)
{
diff --git a/core/src/main/java/org/marketcetera/quickfix/FIXMessageFactory.java b/core/src/main/java/org/marketcetera/quickfix/FIXMessageFactory.java
index aecf43adf0..6de93546b8 100644
--- a/core/src/main/java/org/marketcetera/quickfix/FIXMessageFactory.java
+++ b/core/src/main/java/org/marketcetera/quickfix/FIXMessageFactory.java
@@ -254,7 +254,7 @@ public Message newMarketDataIncrementalRefresh(String inRequestId)
/**
* Create an MDEntry group.
*
- * @param inMessageFactory a FIXMessageFactory value
+ * @param inMsgType a String value
* @param inMdEntryType a char value
* @return a Group value
*/
@@ -270,7 +270,7 @@ public Group createMdEntryGroup(String inMsgType,
* Get the MDEntry groups from the given message.
*
* @param inMessage a Message value
- * @return a List<:Group> value
+ * @return a List<Group> value
* @throws FieldNotFound if the groups could not be extracted
*/
public List getMdEntriesFromMessage(Message inMessage)
diff --git a/core/src/main/java/org/marketcetera/symbol/IterativeSymbolResolver.java b/core/src/main/java/org/marketcetera/symbol/IterativeSymbolResolver.java
index 903b1ea637..6a3e0418d1 100644
--- a/core/src/main/java/org/marketcetera/symbol/IterativeSymbolResolver.java
+++ b/core/src/main/java/org/marketcetera/symbol/IterativeSymbolResolver.java
@@ -120,7 +120,7 @@ public int getCacheSize()
/**
* Sets the cacheSize value.
*
- * @param an int value
+ * @param inCacheSize an int value
*/
public void setCacheSize(int inCacheSize)
{
diff --git a/core/src/main/java/org/marketcetera/symbol/SymbolResolver.java b/core/src/main/java/org/marketcetera/symbol/SymbolResolver.java
index c0711cfad5..2d229e6fea 100644
--- a/core/src/main/java/org/marketcetera/symbol/SymbolResolver.java
+++ b/core/src/main/java/org/marketcetera/symbol/SymbolResolver.java
@@ -26,7 +26,7 @@ public interface SymbolResolver
* Generate a symbol from the given instrument.
*
* @param inInstrument an Instrument value
- * @return a code>String value
+ * @return a String value
*/
String generateSymbol(Instrument inInstrument);
}
diff --git a/core/src/main/java/org/marketcetera/trade/AbstractSuggestion.java b/core/src/main/java/org/marketcetera/trade/AbstractSuggestion.java
index 0ce3429b1e..a666fdee64 100644
--- a/core/src/main/java/org/marketcetera/trade/AbstractSuggestion.java
+++ b/core/src/main/java/org/marketcetera/trade/AbstractSuggestion.java
@@ -53,7 +53,7 @@ protected AbstractSuggestion() {}
/**
* Create a new AbstractSuggestion instance.
*
- * @param inIdentifier a String value
+ * @param inIdentifier a String value
* @param inScore a BigDecimal value
*/
protected AbstractSuggestion(String inIdentifier,
diff --git a/core/src/main/java/org/marketcetera/trade/Instrument.java b/core/src/main/java/org/marketcetera/trade/Instrument.java
index 498c7f0a91..b2530f3c15 100644
--- a/core/src/main/java/org/marketcetera/trade/Instrument.java
+++ b/core/src/main/java/org/marketcetera/trade/Instrument.java
@@ -16,7 +16,7 @@
* Each instrument has a symbol attribute. Sub-types may add more
* attributes as needed to uniquely identify the instrument being traded.
*
- * Each instrument sub-type should override the {@link #equals(Object)} &
+ * Each instrument sub-type should override the {@link #equals(Object)} &
* {@link #hashCode()} methods to ensure that any two instrument instances that
* refer to the same instrument are considered equal.
*
diff --git a/core/src/main/java/org/marketcetera/trade/utils/OrderHistoryManager.java b/core/src/main/java/org/marketcetera/trade/utils/OrderHistoryManager.java
index b6beb7c09b..0389664f83 100644
--- a/core/src/main/java/org/marketcetera/trade/utils/OrderHistoryManager.java
+++ b/core/src/main/java/org/marketcetera/trade/utils/OrderHistoryManager.java
@@ -94,7 +94,7 @@ public ReportBase getLatestReportFor(OrderID inOrderID)
/**
* Adds the given TradeMessage to the order history.
*
- * @param inReport a TradeMessage value
+ * @param inTradeMessage a TradeMessage value
*/
public void add(TradeMessage inTradeMessage)
{
@@ -319,10 +319,10 @@ public String display()
*
The returned Deque does not change and will not reflect future changes.
*
*
The given OrderID may be either an order ID or an original order ID. The reports
- * returned will be the same in either case. If no history exists for the given OrderID,
+ * returned will be the same in either case. If no history exists for the given OrderID,
* an empty Deque is returned.
*
- * The underlying order history is populated by calls to {@link #add(ReportBase)}.
+ *
The underlying order history is populated by calls to {@link #add(TradeMessage)}.
*
* @param inOrderId an OrderID value
* @return a Deque<ReportBase> value which may be empty
diff --git a/core/src/test/java/org/marketcetera/core/AccessViolator.java b/core/src/test/java/org/marketcetera/core/AccessViolator.java
index 3d231a4b6d..1d66debc7d 100644
--- a/core/src/test/java/org/marketcetera/core/AccessViolator.java
+++ b/core/src/test/java/org/marketcetera/core/AccessViolator.java
@@ -37,9 +37,15 @@ public Object invokeMethod(String methodName, Object reference, Object [] args,
theMethod.setAccessible(true);
return theMethod.invoke(reference, args);
}
-
-
- /** Sets the speicified field to the passed-in value */
+ /**
+ * Sets the specified field to the passed-in value
+ *
+ * @param fieldName a String value
+ * @param reference an Object value
+ * @param value an Object value
+ * @throws NoSuchFieldException if the specified field does not exist
+ * @throws IllegalAccessException if access is not allowed
+ */
public void setField(String fieldName, Object reference, Object value)
throws NoSuchFieldException, IllegalAccessException {
Field theField = violatedClass.getDeclaredField(fieldName);
diff --git a/core/src/test/java/org/marketcetera/core/ExpectedTestFailure.java b/core/src/test/java/org/marketcetera/core/ExpectedTestFailure.java
index 8cfd5fbe57..3ef336a453 100644
--- a/core/src/test/java/org/marketcetera/core/ExpectedTestFailure.java
+++ b/core/src/test/java/org/marketcetera/core/ExpectedTestFailure.java
@@ -10,7 +10,7 @@
*
* (new ExpectedTestFailure(OrderParsingException.class) {
* protected void execute() throws OrderParsingException {
- * <... Code throwing exception goes here ... >
+ * <... Code throwing exception goes here ... >
* }}).run();
*
*
@@ -35,11 +35,15 @@ public ExpectedTestFailure(Class inThrowable, String inContains)
/** Subclasses must override this method with an implementation that
* throws their expected error
- * @throws Throwable
+ * @throws Throwable if an error occurs
*/
protected abstract void execute() throws Throwable;
- /** Executes the code that was implemented in @link {execute()} method */
+ /**
+ * Executes the code that was implemented in @link {execute()} method.
+ *
+ * @return a Throwable value
+ */
public Throwable run()
{
try {
diff --git a/core/src/test/java/org/marketcetera/core/ExpectedTestFailureTest.java b/core/src/test/java/org/marketcetera/core/ExpectedTestFailureTest.java
index 7fb026d923..e0eb9d74d4 100644
--- a/core/src/test/java/org/marketcetera/core/ExpectedTestFailureTest.java
+++ b/core/src/test/java/org/marketcetera/core/ExpectedTestFailureTest.java
@@ -51,8 +51,11 @@ protected void execute() throws Throwable
}
-
- /** Check the case when the exception has a message (toString()) but getMessage() returns null */
+ /**
+ * Check the case when the exception has a message (toString()) but getMessage() returns null.
+ *
+ * @throws Exception an Exception value
+ */
public void testExceptinoHasNoMessageButHasString() throws Exception {
final Exception ex = new Exception() {
private static final long serialVersionUID = 1L;
diff --git a/core/src/test/java/org/marketcetera/core/LoggerStartupTest.java b/core/src/test/java/org/marketcetera/core/LoggerStartupTest.java
index 84f16e768a..b6a3d5b1e1 100644
--- a/core/src/test/java/org/marketcetera/core/LoggerStartupTest.java
+++ b/core/src/test/java/org/marketcetera/core/LoggerStartupTest.java
@@ -20,7 +20,7 @@ public static Test suite() {
/** This is a dummy test, mostly for visual checking of whether or not
* the logger is initialized correctly.
- * @throws Exception
+ * @throws Exception if an unexpected error occurs
*/
public void testLogSomething() throws Exception {
new ApplicationBase();
diff --git a/core/src/test/java/org/marketcetera/core/VersionInfoTest.java b/core/src/test/java/org/marketcetera/core/VersionInfoTest.java
index eb53a4eb98..bb3d621031 100644
--- a/core/src/test/java/org/marketcetera/core/VersionInfoTest.java
+++ b/core/src/test/java/org/marketcetera/core/VersionInfoTest.java
@@ -13,7 +13,7 @@
/* $License$ */
/**
- * Tests {@link #VersionInfo}.
+ * Tests {@link VersionInfo}.
*
* @author Colin DuPlantis
* @version $Id$
diff --git a/core/src/test/java/org/marketcetera/core/instruments/InstrumentToMessageTest.java b/core/src/test/java/org/marketcetera/core/instruments/InstrumentToMessageTest.java
index 3fb6f0e765..8a9b2de22d 100644
--- a/core/src/test/java/org/marketcetera/core/instruments/InstrumentToMessageTest.java
+++ b/core/src/test/java/org/marketcetera/core/instruments/InstrumentToMessageTest.java
@@ -604,7 +604,7 @@ protected void run()
}
}
/**
- * Tests {@link InstrumentToMessage#setSecurityType(org.marketcetera.trade.Instrument, String, quickfix.Message)}.
+ * Tests {@link InstrumentToMessage#setSecurityType(org.marketcetera.trade.Instrument, String, quickfix.FieldMap)}.
*
* @throws Exception if there were unexpected errors.
*/
diff --git a/core/src/test/java/org/marketcetera/core/notifications/NotificationManagerTest.java b/core/src/test/java/org/marketcetera/core/notifications/NotificationManagerTest.java
index 8a1d1e823c..3b864f3342 100644
--- a/core/src/test/java/org/marketcetera/core/notifications/NotificationManagerTest.java
+++ b/core/src/test/java/org/marketcetera/core/notifications/NotificationManagerTest.java
@@ -26,7 +26,7 @@ public class NotificationManagerTest
/**
* Tests that the static getter returns a non-null value.
*
- * @throws Exception
+ * @throws Exception if an unexpected error occurs
*/
@Test
public void testGetter()
@@ -40,7 +40,7 @@ public void testGetter()
* Note that this is not an exhaustive test of the {@link PublisherEngine} because
* that is covered in {@link PublisherEngineTest}.
*
- * @throws Exception
+ * @throws Exception if an unexpected error occurs
*/
@Test
public void testSubscribeAndPublish()
diff --git a/core/src/test/java/org/marketcetera/core/position/impl/OrderingComparison.java b/core/src/test/java/org/marketcetera/core/position/impl/OrderingComparison.java
index 9161d829d5..51e546a0b3 100644
--- a/core/src/test/java/org/marketcetera/core/position/impl/OrderingComparison.java
+++ b/core/src/test/java/org/marketcetera/core/position/impl/OrderingComparison.java
@@ -49,36 +49,56 @@ else if (compare == 0) {
/**
* Is value = expected?
+ *
+ * @param type being compared
+ * @param value a T value
+ * @return a Matcher<? super T> value
*/
public static > Matcher comparesEqualTo(T value) {
return new OrderingComparison(value, 0, 0);
}
/**
- * Is value > expected?
+ * Is value > expected?
+ *
+ * @param type being compared
+ * @param value a T value
+ * @return a Matcher<? super T> value
*/
public static > Matcher greaterThan(T value) {
return new OrderingComparison(value, -1, -1);
}
/**
- * Is value >= expected?
+ * Is value >= expected?
+ *
+ * @param type being compared
+ * @param value a T value
+ * @return a Matcher<? super T> value
*/
public static > Matcher greaterThanOrEqualTo(T value) {
return new OrderingComparison(value, -1, 0);
}
/**
- * Is value < expected?
+ * Is value < expected?
+ *
+ * @param type being compared
+ * @param value a T value
+ * @return a Matcher<? super T> value
*/
public static > Matcher lessThan(T value) {
return new OrderingComparison(value, 1, 1);
}
/**
- * Is value <= expected?
+ * Is value <= expected?
+ *
+ * @param type being compared
+ * @param value a T value
+ * @return a Matcher<? super T> value
*/
public static > Matcher lessThanOrEqualTo(T value) {
return new OrderingComparison(value, 0, 1);
}
-}
\ No newline at end of file
+}
diff --git a/core/src/test/java/org/marketcetera/core/position/impl/PositionRowUpdaterConcurrencyTest.java b/core/src/test/java/org/marketcetera/core/position/impl/PositionRowUpdaterConcurrencyTest.java
index ac822bdfef..390df5f30e 100644
--- a/core/src/test/java/org/marketcetera/core/position/impl/PositionRowUpdaterConcurrencyTest.java
+++ b/core/src/test/java/org/marketcetera/core/position/impl/PositionRowUpdaterConcurrencyTest.java
@@ -260,6 +260,8 @@ public final void run() {
/**
* Hook for subclass code to run. Any thrown exception will be reported.
+ *
+ * @throws Exception if an unexpected error occurs
*/
protected abstract void runWithReporting() throws Exception;
}
diff --git a/core/src/test/java/org/marketcetera/event/MockEvent.java b/core/src/test/java/org/marketcetera/event/MockEvent.java
index a7f88c3ee6..ea9fc0423a 100644
--- a/core/src/test/java/org/marketcetera/event/MockEvent.java
+++ b/core/src/test/java/org/marketcetera/event/MockEvent.java
@@ -28,8 +28,8 @@ public MockEvent()
/**
* Create a new MockEvent instance.
*
- * @param inMessageId
- * @param inTimestamp
+ * @param inMessageId a long value
+ * @param inTimestamp a long value
*/
public MockEvent(long inMessageId,
long inTimestamp)
@@ -40,7 +40,7 @@ public MockEvent(long inMessageId,
/**
* Create a new MockEvent instance.
*
- * @param inRequest
+ * @param inRequest a MarketDataRequest value
*/
public MockEvent(MarketDataRequest inRequest)
{
diff --git a/core/src/test/java/org/marketcetera/event/MockEventTranslator.java b/core/src/test/java/org/marketcetera/event/MockEventTranslator.java
index 3d0107c535..daad985f35 100644
--- a/core/src/test/java/org/marketcetera/event/MockEventTranslator.java
+++ b/core/src/test/java/org/marketcetera/event/MockEventTranslator.java
@@ -99,7 +99,7 @@ public static void setTranslateToEventsReturnsNull(boolean inTranslateToEventsRe
/**
* Sets the requestToReturn value.
*
- * @param a DataRequest value
+ * @param inRequestToReturn a DataRequest value
*/
public static void setRequestToReturn(MarketDataRequest inRequestToReturn)
{
diff --git a/core/src/test/java/org/marketcetera/event/QuantityTuple.java b/core/src/test/java/org/marketcetera/event/QuantityTuple.java
index 6bdfa4b05a..74115f82c1 100644
--- a/core/src/test/java/org/marketcetera/event/QuantityTuple.java
+++ b/core/src/test/java/org/marketcetera/event/QuantityTuple.java
@@ -29,6 +29,7 @@ public class QuantityTuple
*
* @param inPrice a BigDecimal value
* @param inSize a BigDecimal value
+ * @param inType a Class<? extends MarketDataEvent> value
*/
public QuantityTuple(BigDecimal inPrice,
BigDecimal inSize,
@@ -59,7 +60,7 @@ public BigDecimal getSize()
/**
* Get the type value.
*
- * @return a Class value
+ * @return a Class<? extends MarketDataEvent> value
*/
public Class getType()
{
diff --git a/core/src/test/java/org/marketcetera/event/beans/DividendBeanTest.java b/core/src/test/java/org/marketcetera/event/beans/DividendBeanTest.java
index 01b50fb5ea..f2d34c4324 100644
--- a/core/src/test/java/org/marketcetera/event/beans/DividendBeanTest.java
+++ b/core/src/test/java/org/marketcetera/event/beans/DividendBeanTest.java
@@ -64,7 +64,7 @@ public void equity()
bean.getInstrumentAsString());
}
/**
- * Tests {@link DividendBean#getAmount()} and {@link DividendBean#setAmount(org.marketcetera.trade.Amount)}.
+ * Tests {@link DividendBean#getAmount()} and {@link DividendBean#setAmount(BigDecimal)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -82,7 +82,7 @@ public void amount()
bean.getAmount());
}
/**
- * Tests {@link DividendBean#getCurrency()} and {@link DividendBean#setCurrency(org.marketcetera.trade.Currency)}.
+ * Tests {@link DividendBean#getCurrency()} and {@link DividendBean#setCurrency(String)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -100,7 +100,7 @@ public void currency()
bean.getCurrency());
}
/**
- * Tests {@link DividendBean#getDeclareDate()} and {@link DividendBean#setDeclareDate(org.marketcetera.trade.DeclareDate)}.
+ * Tests {@link DividendBean#getDeclareDate()} and {@link DividendBean#setDeclareDate(String)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -121,7 +121,7 @@ public void declareDate()
bean.getDeclareDate());
}
/**
- * Tests {@link DividendBean#getExecutionDate()} and {@link DividendBean#setExecutionDate(org.marketcetera.trade.ExecutionDate)}.
+ * Tests {@link DividendBean#getExecutionDate()} and {@link DividendBean#setExecutionDate(String)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -142,7 +142,7 @@ public void executionDate()
bean.getExecutionDate());
}
/**
- * Tests {@link DividendBean#getPaymentDate()} and {@link DividendBean#setPaymentDate(org.marketcetera.trade.PaymentDate)}.
+ * Tests {@link DividendBean#getPaymentDate()} and {@link DividendBean#setPaymentDate(String)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -163,7 +163,7 @@ public void paymentDate()
bean.getPaymentDate());
}
/**
- * Tests {@link DividendBean#getRecordDate()} and {@link DividendBean#setRecordDate(org.marketcetera.trade.RecordDate)}.
+ * Tests {@link DividendBean#getRecordDate()} and {@link DividendBean#setRecordDate(String)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -184,7 +184,7 @@ public void recordDate()
bean.getRecordDate());
}
/**
- * Tests {@link DividendBean#getFrequency()} and {@link DividendBean#setFrequency(org.marketcetera.trade.Frequency)}.
+ * Tests {@link DividendBean#getFrequency()} and {@link DividendBean#setFrequency(DividendFrequency)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -202,7 +202,7 @@ public void frequency()
bean.getFrequency());
}
/**
- * Tests {@link DividendBean#getStatus()} and {@link DividendBean#setStatus(org.marketcetera.trade.Status)}.
+ * Tests {@link DividendBean#getStatus()} and {@link DividendBean#setStatus(DividendStatus)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -220,7 +220,7 @@ public void status()
bean.getStatus());
}
/**
- * Tests {@link DividendBean#getType()} and {@link DividendBean#setType(org.marketcetera.trade.Type)}.
+ * Tests {@link DividendBean#getType()} and {@link DividendBean#setType(DividendType)}.
*
* @throws Exception if an unexpected error occurs
*/
diff --git a/core/src/test/java/org/marketcetera/event/beans/MarketDataBeanTest.java b/core/src/test/java/org/marketcetera/event/beans/MarketDataBeanTest.java
index 525d34b908..407966482d 100644
--- a/core/src/test/java/org/marketcetera/event/beans/MarketDataBeanTest.java
+++ b/core/src/test/java/org/marketcetera/event/beans/MarketDataBeanTest.java
@@ -40,7 +40,7 @@ public void copy()
doCopyTest(new MarketDataBean());
}
/**
- * Tests {@link E#getInstrument()} and {@link E#setInstrument(org.marketcetera.trade.Instrument)}.
+ * Tests getInstrument and setInstrument.
*
* @throws Exception if an unexpected error occurs
*/
diff --git a/core/src/test/java/org/marketcetera/event/beans/MarketstatBeanTest.java b/core/src/test/java/org/marketcetera/event/beans/MarketstatBeanTest.java
index 00df104aa0..7dd5758cb8 100644
--- a/core/src/test/java/org/marketcetera/event/beans/MarketstatBeanTest.java
+++ b/core/src/test/java/org/marketcetera/event/beans/MarketstatBeanTest.java
@@ -365,7 +365,7 @@ public void closeExchange()
bean.getCloseExchange());
}
/**
- * Tests {@link E#getInstrument()} and {@link E#setInstrument(org.marketcetera.trade.Instrument)}.
+ * Tests getInstrument and setInstrument.
*
* @throws Exception if an unexpected error occurs
*/
diff --git a/core/src/test/java/org/marketcetera/event/beans/QuoteBeanTest.java b/core/src/test/java/org/marketcetera/event/beans/QuoteBeanTest.java
index f1c9e6c3dd..83cbd92fb3 100644
--- a/core/src/test/java/org/marketcetera/event/beans/QuoteBeanTest.java
+++ b/core/src/test/java/org/marketcetera/event/beans/QuoteBeanTest.java
@@ -47,7 +47,7 @@ public void copy()
}
/**
* Tests {@link QuoteBean#getQuoteBeanFromEvent(org.marketcetera.event.QuoteEvent, QuoteAction)} and
- * {@link QuoteBean#getQuoteBeanFromEvent(org.marketcetera.event.QuoteEvent, java.util.Date, java.math.BigDecimal, QuoteAction).
+ * {@link QuoteBean#getQuoteBeanFromEvent(org.marketcetera.event.QuoteEvent, java.util.Date, java.math.BigDecimal, QuoteAction)}.
*
* @throws Exception if an unexpected error occurs
*/
diff --git a/core/src/test/java/org/marketcetera/event/impl/LogEventTest.java b/core/src/test/java/org/marketcetera/event/impl/LogEventTest.java
index f3f6aeb456..9d93ea3264 100644
--- a/core/src/test/java/org/marketcetera/event/impl/LogEventTest.java
+++ b/core/src/test/java/org/marketcetera/event/impl/LogEventTest.java
@@ -26,7 +26,7 @@
import org.marketcetera.util.log.I18NMessageNP;
/**
- * Tests {@link LogEventBuilder} and {@link LinkEventImpl}.
+ * Tests {@link LogEventBuilder} and {@link LogEventImpl}.
*
* @author Colin DuPlantis
* @version $Id$
diff --git a/core/src/test/java/org/marketcetera/event/impl/QuoteEventTest.java b/core/src/test/java/org/marketcetera/event/impl/QuoteEventTest.java
index 97f42ba041..2e635f8e0c 100644
--- a/core/src/test/java/org/marketcetera/event/impl/QuoteEventTest.java
+++ b/core/src/test/java/org/marketcetera/event/impl/QuoteEventTest.java
@@ -550,7 +550,7 @@ public void withContractSize()
verify(builder);
}
/**
- * Tests {@link QuoteEventBuilder#withInstrument(Instrument)}.
+ * Tests QuoteEventBuilder.withInstrument.
*
* @throws Exception if an unexpected error occurs
*/
@@ -624,7 +624,7 @@ public void withMessageId()
verify(builder);
}
/**
- * Tests {@link QuoteEventBuilder#withMultiplier(int)}.
+ * Tests {@link QuoteEventBuilder#withMultiplier(BigDecimal)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -720,7 +720,7 @@ public void withPrice()
verify(builder);
}
/**
- * Tests {@link QuoteEventBuilder#withQuoteDate(String)}.
+ * Tests {@link QuoteEventBuilder#withQuoteDate(Date)}.
*
* @throws Exception if an unexpected error occurs
*/
diff --git a/core/src/test/java/org/marketcetera/event/impl/TradeEventTest.java b/core/src/test/java/org/marketcetera/event/impl/TradeEventTest.java
index 3ee9c9e447..53ab1b94db 100644
--- a/core/src/test/java/org/marketcetera/event/impl/TradeEventTest.java
+++ b/core/src/test/java/org/marketcetera/event/impl/TradeEventTest.java
@@ -350,7 +350,7 @@ public void withMessageId()
verify(builder);
}
/**
- * Tests {@link TradeEventBuilder#withMultiplier(int)}.
+ * Tests {@link TradeEventBuilder#withMultiplier(BigDecimal)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -398,7 +398,7 @@ public void withPrice()
verify(builder);
}
/**
- * Tests {@link TradeEventBuilder#withTradeDate(String)}.
+ * Tests {@link TradeEventBuilder#withTradeDate(Date)}.
*
* @throws Exception if an unexpected error occurs
*/
diff --git a/core/src/test/java/org/marketcetera/marketdata/DateUtilsTest.java b/core/src/test/java/org/marketcetera/marketdata/DateUtilsTest.java
index 06adda3515..2fd519086b 100644
--- a/core/src/test/java/org/marketcetera/marketdata/DateUtilsTest.java
+++ b/core/src/test/java/org/marketcetera/marketdata/DateUtilsTest.java
@@ -23,7 +23,7 @@
/* $License$ */
/**
- * Tests {@link DateUtil}.
+ * Tests {@link DateUtils}.
*
* @author Colin DuPlantis
* @version $Id$
diff --git a/core/src/test/java/org/marketcetera/marketdata/MarketDataRequestTest.java b/core/src/test/java/org/marketcetera/marketdata/MarketDataRequestTest.java
index ac203ab03c..3f0916ace5 100644
--- a/core/src/test/java/org/marketcetera/marketdata/MarketDataRequestTest.java
+++ b/core/src/test/java/org/marketcetera/marketdata/MarketDataRequestTest.java
@@ -922,7 +922,7 @@ protected void run()
}
/**
* Tests {@link MarketDataRequestBuilder#withContent(String)}, {@link MarketDataRequestBuilder#withContent(String...)},
- * {@link MarketDataRequestBuilder#withContent(Content...), and {@link MarketDataRequestBuilder#withContent(Collection)}.
+ * {@link MarketDataRequestBuilder#withContent(Content...)}, and {@link MarketDataRequestBuilder#withContent(Collection)}.
*
* @throws Exception if an unexpected error occurs
*/
diff --git a/core/src/test/java/org/marketcetera/marketdata/MockMarketDataFeed.java b/core/src/test/java/org/marketcetera/marketdata/MockMarketDataFeed.java
index 6e4767ba65..e21a46ad32 100644
--- a/core/src/test/java/org/marketcetera/marketdata/MockMarketDataFeed.java
+++ b/core/src/test/java/org/marketcetera/marketdata/MockMarketDataFeed.java
@@ -133,7 +133,7 @@ public void setCapabilities(Set inCapabilities)
/**
* Sets the supported asset classes for this feed.
*
- * @param inAssetClasses a Set<AssetClass> value
+ * @param inAssetClasses a Set<AssetClass> value
*/
public void setAssetClasses(Set inAssetClasses)
{
@@ -277,7 +277,7 @@ public boolean getLoginFails()
/**
* Sets the allowLogin value.
*
- * @param a TestMarketDataFeed value
+ * @param inAllowLogin a TestMarketDataFeed value
*/
public void setLoginFails(boolean inAllowLogin)
{
@@ -297,7 +297,7 @@ public boolean isInitFails()
/**
* Sets the initFails value.
*
- * @param a TestMarketDataFeed value
+ * @param inInitFails a TestMarketDataFeed value
*/
public void setInitFails(boolean inInitFails)
{
@@ -333,7 +333,7 @@ public boolean getExecutionFails()
/**
* Sets the executionFails value.
*
- * @param a TestMarketDataFeed value
+ * @param inExecutionFails a TestMarketDataFeed value
*/
public void setExecutionFails(boolean inExecutionFails)
{
@@ -383,7 +383,7 @@ public boolean isCancelFails()
/**
* Sets the cancelFails value.
*
- * @param a TestMarketDataFeed value
+ * @param inCancelFails a TestMarketDataFeed value
*/
public void setCancelFails(boolean inCancelFails)
{
@@ -518,7 +518,7 @@ public boolean getShouldTimeout()
/**
* Sets the timeout value.
*
- * @param a TestMarketDataFeed value
+ * @param inTimeout a TestMarketDataFeed value
*/
public void setShouldTimeout(boolean inTimeout)
{
diff --git a/core/src/test/java/org/marketcetera/metrics/InfoTests.java b/core/src/test/java/org/marketcetera/metrics/InfoTests.java
index 2fc3e2d783..5efd61d897 100644
--- a/core/src/test/java/org/marketcetera/metrics/InfoTests.java
+++ b/core/src/test/java/org/marketcetera/metrics/InfoTests.java
@@ -9,7 +9,7 @@
/* $License$ */
/**
- * Tests {@link CheckpointInfo}, {@link IterationInfo} & {@link PerThreadInfo}.
+ * Tests {@link CheckpointInfo}, {@link IterationInfo} & {@link PerThreadInfo}.
*
* @author anshul@marketcetera.com
* @version $Id$
diff --git a/core/src/test/java/org/marketcetera/metrics/PrintStreamFactoryTest.java b/core/src/test/java/org/marketcetera/metrics/PrintStreamFactoryTest.java
index 76e27d48d8..fd9151026e 100644
--- a/core/src/test/java/org/marketcetera/metrics/PrintStreamFactoryTest.java
+++ b/core/src/test/java/org/marketcetera/metrics/PrintStreamFactoryTest.java
@@ -12,7 +12,7 @@
/* $License$ */
/**
- * Tests {@link PrintStreamFactory} subclasses, {@link FileStreamFactory} &
+ * Tests {@link PrintStreamFactory} subclasses, {@link FileStreamFactory} &
* {@link StdErrFactory}
*
* @author anshul@marketcetera.com
diff --git a/core/src/test/java/org/marketcetera/module/DataFlowTest.java b/core/src/test/java/org/marketcetera/module/DataFlowTest.java
index 72a0329987..0e04409e86 100644
--- a/core/src/test/java/org/marketcetera/module/DataFlowTest.java
+++ b/core/src/test/java/org/marketcetera/module/DataFlowTest.java
@@ -97,7 +97,7 @@ protected void run() throws Exception {
}
/**
- * Tests creation & cancellation of simple data flows through the module
+ * Tests creation & cancellation of simple data flows through the module
* manager API.
*
* @throws Exception if there's an unexpected error.
@@ -172,7 +172,7 @@ public void emitFailStoppedFlow() throws Exception {
}
/**
- * Tests creation & cancellation of simple data flows through the
+ * Tests creation & cancellation of simple data flows through the
* data flow support interface.
*
* @throws Exception if there's an unexpected error.
@@ -270,7 +270,7 @@ protected void run() throws Exception {
/**
* Verifies that attempts to invoke data flow setup/cancel APIs, in
* {@link DataFlowSupport}, from within
- * {@link DataEmitter#requestData(DataRequest, DataEmitterSupport)} &
+ * {@link DataEmitter#requestData(DataRequest, DataEmitterSupport)} &
* {@link DataEmitter#cancel(DataFlowID, RequestID)} fails.
*
* @throws Exception if there were errors.
diff --git a/core/src/test/java/org/marketcetera/module/ExpectedFailure.java b/core/src/test/java/org/marketcetera/module/ExpectedFailure.java
index 70e7b2f3f6..0f227298af 100644
--- a/core/src/test/java/org/marketcetera/module/ExpectedFailure.java
+++ b/core/src/test/java/org/marketcetera/module/ExpectedFailure.java
@@ -199,7 +199,7 @@ protected ExpectedFailure(String inMessage, boolean inExactMatch)
/**
* Subclasses should implement this method to execute
* code that is expected to fail with the exception of type
- * T
+ * T.
*
* @throws Exception if there's a failure.
*/
diff --git a/core/src/test/java/org/marketcetera/module/LifecycleTest.java b/core/src/test/java/org/marketcetera/module/LifecycleTest.java
index e1418ffb45..34b8d76c95 100644
--- a/core/src/test/java/org/marketcetera/module/LifecycleTest.java
+++ b/core/src/test/java/org/marketcetera/module/LifecycleTest.java
@@ -20,7 +20,7 @@
/* $License$ */
/**
- * Tests Module provider and module lifecycle & information reporting.
+ * Tests Module provider and module lifecycle & information reporting.
*
* @author anshul@marketcetera.com
*/
diff --git a/core/src/test/java/org/marketcetera/module/ModuleConcurrencyTest.java b/core/src/test/java/org/marketcetera/module/ModuleConcurrencyTest.java
index 1ae84a3ffe..b926662395 100644
--- a/core/src/test/java/org/marketcetera/module/ModuleConcurrencyTest.java
+++ b/core/src/test/java/org/marketcetera/module/ModuleConcurrencyTest.java
@@ -276,7 +276,7 @@ protected void run() throws Exception {
}
/**
- * Tests locking & module operations when module start takes a long time
+ * Tests locking & module operations when module start takes a long time
* to complete and succeeds.
*
* @throws Exception if there were errors.
@@ -306,7 +306,7 @@ public void moduleBlockedPreStartPass() throws Exception {
getManager().deleteModule(urn);
}
/**
- * Tests locking & module operations when module start takes a long time
+ * Tests locking & module operations when module start takes a long time
* to complete and fails.
*
* @throws Exception if there were errors.
@@ -338,7 +338,7 @@ protected void run() throws Exception {
getManager().deleteModule(urn);
}
/**
- * Tests locking & module operations when module's setFlowSupport
+ * Tests locking & module operations when module's setFlowSupport
* API takes a lot of time. Do note that setFlowSupport is meant
* to be doing anything complicated. This unit test is there to
* verify that the system is robust enough to deal with a rogue
@@ -372,7 +372,7 @@ public void moduleBlockedSetFlowSupport() throws Exception {
}
/**
- * Verifies locking & module operations when stopping module instances.
+ * Verifies locking & module operations when stopping module instances.
*
* @throws Exception if there were errors
*/
@@ -399,7 +399,7 @@ public void moduleBlockedPreStopPass() throws Exception {
}
/**
- * Verifies locking & module operations when stopping module instance fails.
+ * Verifies locking & module operations when stopping module instance fails.
*
* @throws Exception if there were errors
*/
diff --git a/core/src/test/java/org/marketcetera/module/ProviderLoadTest.java b/core/src/test/java/org/marketcetera/module/ProviderLoadTest.java
index b37864bc4a..2fe998fa5e 100644
--- a/core/src/test/java/org/marketcetera/module/ProviderLoadTest.java
+++ b/core/src/test/java/org/marketcetera/module/ProviderLoadTest.java
@@ -26,7 +26,7 @@ public void cleanup() throws Exception {
mManager.stop();
}
/**
- * Tests various failures in {@link ModuleManager#init()} &
+ * Tests various failures in {@link ModuleManager#init()} &
* {@link ModuleManager#refresh()}
* and their expected behavior.
*
diff --git a/core/src/test/java/org/marketcetera/options/OptionUtilsTest.java b/core/src/test/java/org/marketcetera/options/OptionUtilsTest.java
index 1b6b0a9cb3..06c99d9f16 100644
--- a/core/src/test/java/org/marketcetera/options/OptionUtilsTest.java
+++ b/core/src/test/java/org/marketcetera/options/OptionUtilsTest.java
@@ -30,7 +30,7 @@
public class OptionUtilsTest {
/**
- * Verifies {@link OptionUtils#normalizeEquityOptionExpiry(String)} &
+ * Verifies {@link OptionUtils#normalizeEquityOptionExpiry(String)} &
* {@link OptionUtils#normalizeUSEquityOptionExpiry(String)}.
*
* @throws Exception if there were unexpected errors
diff --git a/core/src/test/java/org/marketcetera/trade/utils/OrderHistoryManagerTest.java b/core/src/test/java/org/marketcetera/trade/utils/OrderHistoryManagerTest.java
index b128383a25..e51ba9ace6 100644
--- a/core/src/test/java/org/marketcetera/trade/utils/OrderHistoryManagerTest.java
+++ b/core/src/test/java/org/marketcetera/trade/utils/OrderHistoryManagerTest.java
@@ -116,7 +116,7 @@ public void testGetLatestReportFor()
assertNull(manager.getLatestReportFor(new OrderID("some-orderid-that-doesn't-exist")));
}
/**
- * Tests {@link OrderHistoryManager#add(ReportBase)}.
+ * Tests {@link OrderHistoryManager#add(TradeMessage)}.
*
* @throws Exception if an unexpected error occurs
*/
@@ -555,7 +555,7 @@ public void testOrderChain()
assertTrue(report6OrderChain.isEmpty());
}
/**
- * Tests {@link LiveOrderHistoryManager#getOpenOrders()}.
+ * Tests {@link OrderHistoryManager#getOpenOrders()}.
*
* @throws Exception if an unexpected error occurs
*/
diff --git a/dare/src/main/java/org/marketcetera/dare/DeployAnywhereRoutingEngine.java b/dare/src/main/java/org/marketcetera/dare/DeployAnywhereRoutingEngine.java
index c69462f2a9..2317ec82f2 100644
--- a/dare/src/main/java/org/marketcetera/dare/DeployAnywhereRoutingEngine.java
+++ b/dare/src/main/java/org/marketcetera/dare/DeployAnywhereRoutingEngine.java
@@ -650,7 +650,7 @@ public void sessionDisabled(FixSessionDisabledEvent inEvent)
/**
* Indicates that the given FIX session has been enabled.
*
- * @param fixSession a FixSessionEnabledEvent value
+ * @param inEvent a FixSessionEnabledEvent value
*/
@Subscribe
public void sessionEnabled(FixSessionEnabledEvent inEvent)
diff --git a/dare/src/test/java/org/marketcetera/test/AbstractMockFixApplication.java b/dare/src/test/java/org/marketcetera/test/AbstractMockFixApplication.java
index 0b0959e0d1..b2529d4bfa 100644
--- a/dare/src/test/java/org/marketcetera/test/AbstractMockFixApplication.java
+++ b/dare/src/test/java/org/marketcetera/test/AbstractMockFixApplication.java
@@ -322,7 +322,7 @@ public void setFixSettingsProviderFactory(FixSettingsProviderFactory inFixSettin
*
* @param inSessionId a quickfix.SessionID value
* @param inMessage a quickfix.Message value
- * @param inMessageContainers a Map<quickfix.SessionID,BlockingDeque<quickfix.Message>>
+ * @param inMessageContainers a Map<quickfix.SessionID,BlockingDeque<quickfix.Message>>
* @throws quickfix.FieldNotFound if the message could not be added
*/
protected void addMessageToContainer(String inLabel,
diff --git a/dare/src/test/java/org/marketcetera/test/DareTestBase.java b/dare/src/test/java/org/marketcetera/test/DareTestBase.java
index 61368baabe..9697c89ef5 100644
--- a/dare/src/test/java/org/marketcetera/test/DareTestBase.java
+++ b/dare/src/test/java/org/marketcetera/test/DareTestBase.java
@@ -566,7 +566,7 @@ public Boolean call()
* @param inRootOrderId an OrderID value
* @param inOrderId an OrderID value
* @param inExpectedOrderStatus an OrderStatus value
- * @param return an OrderSummary value
+ * @return an OrderSummary value
* @throws Exception if an unexpected error occurs
*/
protected OrderSummary verifyOrderStatus(final OrderID inRootOrderId,
@@ -595,7 +595,7 @@ public Boolean call()
*
* @param inRootOrderId an OrderID value
* @param inOrderId an OrderID value
- * @param return an OrderSummary value
+ * @return an OrderSummary value
* @throws Exception if an unexpected error occurs
*/
protected OrderSummary findOrderStatus(final OrderID inRootOrderId,
@@ -2701,8 +2701,6 @@ public quickfix.Message generateAndSendReport(quickfix.Message inMessage,
* Generate and send an ack for the given new order.
*
* @param inMessage a quickfix.Message value
- * @param inOrderStatus an OrderStatus value
- * @param inExecutionType an ExecutionType value
* @return a quickfix.Message value
* @throws Exception if the message could not be sent
*/
@@ -2714,14 +2712,11 @@ public quickfix.Message generateAndSendAck(quickfix.Message inMessage)
ExecutionType.New);
}
/**
- *
- *
+ * Generate and send a cancel ack for the given order.
*
- * @param inMessage
- * @param inOrderStatus
- * @param inExecutionType
- * @return
- * @throws Exception
+ * @param inMessage a quickfix.Message value
+ * @return a quickfix.Message value
+ * @throws Exception if the message could not be sent
*/
public quickfix.Message generateAndSendCancelAck(quickfix.Message inMessage)
throws Exception
diff --git a/dare/src/test/java/org/marketcetera/test/TestDirectoryManager.java b/dare/src/test/java/org/marketcetera/test/TestDirectoryManager.java
index 937fcc2ac0..62ff5be8bd 100644
--- a/dare/src/test/java/org/marketcetera/test/TestDirectoryManager.java
+++ b/dare/src/test/java/org/marketcetera/test/TestDirectoryManager.java
@@ -22,7 +22,7 @@ public class TestDirectoryManager
/**
* Get the testDirectories value.
*
- * @return a List value
+ * @return a List<String> value
*/
public List getTestDirectories()
{
@@ -31,7 +31,7 @@ public List getTestDirectories()
/**
* Sets the testDirectories value.
*
- * @param inTestDirectories a List value
+ * @param inTestDirectories a List<String> value
*/
public void setTestDirectories(List inTestDirectories)
{
@@ -40,7 +40,7 @@ public void setTestDirectories(List inTestDirectories)
/**
* Get the deleteDirectories value.
*
- * @return a List value
+ * @return a List<String> value
*/
public List getDeleteDirectories()
{
@@ -49,7 +49,7 @@ public List getDeleteDirectories()
/**
* Sets the deleteDirectories value.
*
- * @param inDeleteDirectories a List value
+ * @param inDeleteDirectories a List<String> value
*/
public void setDeleteDirectories(List inDeleteDirectories)
{
diff --git a/fix/fix-api/src/main/java/org/marketcetera/brokers/LogoutAction.java b/fix/fix-api/src/main/java/org/marketcetera/brokers/LogoutAction.java
index 953e3e3f2c..ab2c3890e7 100644
--- a/fix/fix-api/src/main/java/org/marketcetera/brokers/LogoutAction.java
+++ b/fix/fix-api/src/main/java/org/marketcetera/brokers/LogoutAction.java
@@ -20,6 +20,6 @@ public interface LogoutAction
* @param inFixSession a ServerFixSession value
* @param inSender a QuickFIXSender value
*/
- public void onLogout(ServerFixSession FixSession,
+ public void onLogout(ServerFixSession inFixSession,
QuickFIXSender inSender);
}
diff --git a/fix/fix-api/src/main/java/org/marketcetera/brokers/service/BrokerService.java b/fix/fix-api/src/main/java/org/marketcetera/brokers/service/BrokerService.java
index 1fa145fc14..66435c0baf 100644
--- a/fix/fix-api/src/main/java/org/marketcetera/brokers/service/BrokerService.java
+++ b/fix/fix-api/src/main/java/org/marketcetera/brokers/service/BrokerService.java
@@ -135,8 +135,8 @@ void reportBrokerStatusFromAll(FixSession inFixSession,
/**
* Finds the fix session corresponding to the given broker ID.
*
- * @param inBrokerId a String value
- * @return a FixSession value or null
+ * @param inBrokerId a String value
+ * @return a FixSession value or null
*/
FixSession findFixSessionByBrokerId(BrokerID inBrokerId);
/**
@@ -168,7 +168,7 @@ void reportBrokerStatusFromAll(FixSession inFixSession,
*/
AcceptorSessionAttributes getFixSettingsFor(int inAffinity);
/**
- * Generates a SessionSettings value based on the given collection of fix sessions.
+ * Generates a SessionSettings value based on the given collection of fix sessions.
*
* @param inFixSessions a Collection<FixSession> value
* @return a SessionSettings value
diff --git a/fix/fix-api/src/main/java/org/marketcetera/brokers/service/FixSessionProvider.java b/fix/fix-api/src/main/java/org/marketcetera/brokers/service/FixSessionProvider.java
index e763f48eec..27daf8914d 100644
--- a/fix/fix-api/src/main/java/org/marketcetera/brokers/service/FixSessionProvider.java
+++ b/fix/fix-api/src/main/java/org/marketcetera/brokers/service/FixSessionProvider.java
@@ -25,14 +25,14 @@ public interface FixSessionProvider
/**
* Finds the fix session corresponding to the given name.
*
- * @param inFixSessionName a String value
- * @return a FixSession value or null
+ * @param inFixSessionName a String value
+ * @return a FixSession value or null
*/
FixSession findFixSessionByName(String inFixSessionName);
/**
* Finds the fix session with the given session id.
*
- * @param inFixSessionListener a FixSessionListener value
+ * @param inSessionId a SessionID value
* @return a FixSession value or null
*/
FixSession findFixSessionBySessionId(SessionID inSessionId);
@@ -58,8 +58,8 @@ public interface FixSessionProvider
/**
* Finds the fix session corresponding to the given broker ID.
*
- * @param inBrokerId a String value
- * @return a FixSession value or null
+ * @param inBrokerId a BrokerID value
+ * @return a FixSession value or null
*/
FixSession findFixSessionByBrokerId(BrokerID inBrokerId);
/**
diff --git a/fix/fix-api/src/main/java/org/marketcetera/fix/ActiveFixSessionFactory.java b/fix/fix-api/src/main/java/org/marketcetera/fix/ActiveFixSessionFactory.java
index 2d6228226c..8ed129a8c8 100644
--- a/fix/fix-api/src/main/java/org/marketcetera/fix/ActiveFixSessionFactory.java
+++ b/fix/fix-api/src/main/java/org/marketcetera/fix/ActiveFixSessionFactory.java
@@ -24,9 +24,9 @@ public interface ActiveFixSessionFactory
/**
* Create an ActiveFixSession object.
*
- * @param inFixSession a FixSession value
- * @param inClusterData a ClusterData value
- * @param inStatus a FixSessionStatus value
+ * @param inUnderlyingFixSession a FixSession value
+ * @param inInstanceData a ClusterData value
+ * @param inBrokerStatus a FixSessionStatus value
* @param inSessionCustomization a SessionCustomization value
* @return an ActiveFixSession value
*/
diff --git a/fix/fix-api/src/main/java/org/marketcetera/fix/MutableActiveFixSession.java b/fix/fix-api/src/main/java/org/marketcetera/fix/MutableActiveFixSession.java
index ab187cc773..8c0e583cc6 100644
--- a/fix/fix-api/src/main/java/org/marketcetera/fix/MutableActiveFixSession.java
+++ b/fix/fix-api/src/main/java/org/marketcetera/fix/MutableActiveFixSession.java
@@ -33,7 +33,7 @@ public interface MutableActiveFixSession
/**
* Set the session status.
*
- * @param inSessionStatus a FixSessionStatus value
+ * @param inFixSessionStatus a FixSessionStatus value
*/
void setStatus(FixSessionStatus inFixSessionStatus);
/**
@@ -51,7 +51,7 @@ public interface MutableActiveFixSession
/**
* Set the brokerAlgos value.
*
- * @param a Set<BrokerAlgoSpec> value
+ * @param inBrokerAlgoSpecs a Set<BrokerAlgoSpec> value
*/
void setBrokerAlgos(Set inBrokerAlgoSpecs);
}
diff --git a/fix/fix-api/src/main/java/org/marketcetera/fix/MutableActiveFixSessionFactory.java b/fix/fix-api/src/main/java/org/marketcetera/fix/MutableActiveFixSessionFactory.java
index 4f2969bd4a..f8a2a6c4f1 100644
--- a/fix/fix-api/src/main/java/org/marketcetera/fix/MutableActiveFixSessionFactory.java
+++ b/fix/fix-api/src/main/java/org/marketcetera/fix/MutableActiveFixSessionFactory.java
@@ -32,9 +32,9 @@ public interface MutableActiveFixSessionFactory
/**
* Create a MutableActiveFixSession object.
*
- * @param inFixSession a FixSession value
- * @param inClusterData a ClusterData value
- * @param inStatus a FixSessionStatus value
+ * @param inUnderlyingFixSession a FixSession value
+ * @param inInstanceData a ClusterData value
+ * @param inBrokerStatus a FixSessionStatus value
* @param inSessionCustomization a SessionCustomization value
* @return a MutableActiveFixSession value
*/
diff --git a/fix/fix-api/src/main/java/org/marketcetera/fix/SessionNameProvider.java b/fix/fix-api/src/main/java/org/marketcetera/fix/SessionNameProvider.java
index 1872e34ffc..9925dd6532 100644
--- a/fix/fix-api/src/main/java/org/marketcetera/fix/SessionNameProvider.java
+++ b/fix/fix-api/src/main/java/org/marketcetera/fix/SessionNameProvider.java
@@ -16,9 +16,9 @@ public interface SessionNameProvider
/**
* Get the name of the given session.
*
- * This method is intended to be light-weight to be called frequently with minimal trips to the database.
+ * This method is intended to be light-weight to be called frequently with minimal trips to the database.
* As such, it is possible that the value returned may, under certain circumstances, be inaccurate due to caching.
- * This is unlikely to happen, but is possible due to the emphasis on performance.
+ * This is unlikely to happen, but is possible due to the emphasis on performance.
*
* @param inSessionId a SessionID value
* @return a String value, never null
diff --git a/fix/fix-api/src/main/java/org/marketcetera/fix/SessionRestoreArbiter.java b/fix/fix-api/src/main/java/org/marketcetera/fix/SessionRestoreArbiter.java
index b984c1e5a0..fd8c528d16 100644
--- a/fix/fix-api/src/main/java/org/marketcetera/fix/SessionRestoreArbiter.java
+++ b/fix/fix-api/src/main/java/org/marketcetera/fix/SessionRestoreArbiter.java
@@ -16,7 +16,7 @@ public interface SessionRestoreArbiter
/**
* Indicates if the given session should be restored or allowed to start as-is.
*
- * @param inSessionId a SessionID value
+ * @param inSessionId a SessionID value
* @return a boolean
*/
boolean shouldRestore(SessionID inSessionId);
diff --git a/fix/fix-core/src/main/java/org/marketcetera/fix/FixSettingsProviderImpl.java b/fix/fix-core/src/main/java/org/marketcetera/fix/FixSettingsProviderImpl.java
index 1d509df52b..dd681a2b23 100644
--- a/fix/fix-core/src/main/java/org/marketcetera/fix/FixSettingsProviderImpl.java
+++ b/fix/fix-core/src/main/java/org/marketcetera/fix/FixSettingsProviderImpl.java
@@ -27,7 +27,7 @@ public class FixSettingsProviderImpl
* @param inLogFactoryClass a Class<LogFactory> value
* @param inMessageFactory a MessageFactory value
* @param inAcceptorHost a String value
- * @param inAcceptorProtocol a String value
+ * @param inAcceptorProtocol a String value
* @param inAcceptorPort an int value
*/
public FixSettingsProviderImpl(Class inMessageStoreFactoryClass,
diff --git a/fix/fix-core/src/test/java/org/marketcetera/brokers/MockBrokerStatusGenerator.java b/fix/fix-core/src/test/java/org/marketcetera/brokers/MockBrokerStatusGenerator.java
index fd745eba14..bafb0836fd 100644
--- a/fix/fix-core/src/test/java/org/marketcetera/brokers/MockBrokerStatusGenerator.java
+++ b/fix/fix-core/src/test/java/org/marketcetera/brokers/MockBrokerStatusGenerator.java
@@ -14,7 +14,7 @@
/* $License$ */
/**
- * Generates test {@link BrokerStatus} values.
+ * Generates test {@link ActiveFixSession} values.
*
* @author Colin DuPlantis
* @version $Id$
diff --git a/fix/fix-rpc-core/src/main/java/org/marketcetera/fix/FixRpcUtil.java b/fix/fix-rpc-core/src/main/java/org/marketcetera/fix/FixRpcUtil.java
index 9a4e16798d..162a81d018 100644
--- a/fix/fix-rpc-core/src/main/java/org/marketcetera/fix/FixRpcUtil.java
+++ b/fix/fix-rpc-core/src/main/java/org/marketcetera/fix/FixRpcUtil.java
@@ -246,7 +246,7 @@ public static Optional getRpcActiveFixSession(Acti
/**
* Get the RPC value from the given value.
*
- * @param inBrokerAlgoSpec a BrokerAlgoSpec value
+ * @param inBrokerAlgoSpec a BrokerAlgoSpec value
* @return an Optional<FixAdminRpc.BrokerAlgoSpec> value
*/
public static Optional getRpcBrokerAlgo(BrokerAlgoSpec inBrokerAlgoSpec)
diff --git a/fix/fix-server/src/main/java/org/marketcetera/fix/provisioning/FixSessionsConfiguration.java b/fix/fix-server/src/main/java/org/marketcetera/fix/provisioning/FixSessionsConfiguration.java
index 91b8ce6674..0f4848c144 100644
--- a/fix/fix-server/src/main/java/org/marketcetera/fix/provisioning/FixSessionsConfiguration.java
+++ b/fix/fix-server/src/main/java/org/marketcetera/fix/provisioning/FixSessionsConfiguration.java
@@ -27,7 +27,7 @@ public class FixSessionsConfiguration
/**
* Get the sessionDescriptors value.
*
- * @return a List value
+ * @return a List<FixSessionDescriptor> value
*/
public List getSessionDescriptors()
{
@@ -36,7 +36,7 @@ public List getSessionDescriptors()
/**
* Sets the sessionDescriptors value.
*
- * @param inSessionDescriptors a List value
+ * @param inSessionDescriptors a List<FixSessionDescriptor> value
*/
public void setSessionDescriptors(List inSessionDescriptors)
{
@@ -75,7 +75,7 @@ public String toString()
/**
* Get the settings value.
*
- * @return a Map value
+ * @return a Map<String,String> value
*/
public Map getSettings()
{
@@ -84,7 +84,7 @@ public Map getSettings()
/**
* Sets the settings value.
*
- * @param inSettings a Map value
+ * @param inSettings a Map<String,String> value
*/
public void setSettings(Map inSettings)
{
@@ -93,7 +93,7 @@ public void setSettings(Map inSettings)
/**
* Get the sessions value.
*
- * @return a List value
+ * @return a List<Session> value
*/
public List getSessions()
{
@@ -102,7 +102,7 @@ public List getSessions()
/**
* Sets the sessions value.
*
- * @param inSessions a List value
+ * @param inSessions a List<Session> value
*/
public void setSessions(List inSessions)
{
@@ -268,7 +268,7 @@ public void setAffinity(int inAffinity)
/**
* Get the settings value.
*
- * @return a Map value
+ * @return a Map<String,String> value
*/
public Map getSettings()
{
@@ -277,7 +277,7 @@ public Map getSettings()
/**
* Sets the settings value.
*
- * @param inSettings a Map value
+ * @param inSettings a Map<String,String> value
*/
public void setSettings(Map inSettings)
{
diff --git a/fix/fix-server/src/main/java/org/marketcetera/fix/provisioning/SimpleSessionCustomization.java b/fix/fix-server/src/main/java/org/marketcetera/fix/provisioning/SimpleSessionCustomization.java
index 02686562b0..ce003755a0 100644
--- a/fix/fix-server/src/main/java/org/marketcetera/fix/provisioning/SimpleSessionCustomization.java
+++ b/fix/fix-server/src/main/java/org/marketcetera/fix/provisioning/SimpleSessionCustomization.java
@@ -118,7 +118,7 @@ public void setResponseModifiers(List inResponseModifiers)
/**
* Sets the brokerAlgos value.
*
- * @param inBrokerAlgos a Set value
+ * @param inBrokerAlgos a Set<BrokerAlgoSpec> value
*/
public void setBrokerAlgos(Set inBrokerAlgos)
{
@@ -127,7 +127,7 @@ public void setBrokerAlgos(Set inBrokerAlgos)
/**
* Sets the userWhitelist value.
*
- * @param inUserWhitelist a Set value
+ * @param inUserWhitelist a Set<String> value
*/
public void setUserWhitelist(Set inUserWhitelist)
{
@@ -136,7 +136,7 @@ public void setUserWhitelist(Set inUserWhitelist)
/**
* Sets the userBlacklist value.
*
- * @param inUserBlacklist a Set value
+ * @param inUserBlacklist a Set<String> value
*/
public void setUserBlacklist(Set inUserBlacklist)
{
diff --git a/fork/commons-csv/src/java/org/apache/commons/csv/CSVParser.java b/fork/commons-csv/src/java/org/apache/commons/csv/CSVParser.java
index 839a9b2583..d6e7b4e4de 100644
--- a/fork/commons-csv/src/java/org/apache/commons/csv/CSVParser.java
+++ b/fork/commons-csv/src/java/org/apache/commons/csv/CSVParser.java
@@ -288,6 +288,9 @@ public int getLineNumber() {
/**
* Convenience method for nextToken(null).
+ *
+ * @return a Token value
+ * @throws IOException if an error occurs
*/
protected Token nextToken() throws IOException {
return nextToken(new Token());
@@ -563,6 +566,7 @@ private int readEscape(int c) throws IOException {
/**
* Sets the specified CSV Strategy
*
+ * @param strategy a CSVStrategy value
* @return current instance of CSVParser to allow chained method calls
* @deprecated the strategy should be set in the constructor {@link #CSVParser(Reader,CSVStrategy)}.
*/
diff --git a/fork/commons-csv/src/java/org/apache/commons/csv/CSVPrinter.java b/fork/commons-csv/src/java/org/apache/commons/csv/CSVPrinter.java
index a57d03aef8..644f50150f 100644
--- a/fork/commons-csv/src/java/org/apache/commons/csv/CSVPrinter.java
+++ b/fork/commons-csv/src/java/org/apache/commons/csv/CSVPrinter.java
@@ -69,6 +69,7 @@ public CSVPrinter(Writer out) {
/**
* Sets the specified CSV Strategy
*
+ * @param strategy a CSVStrategy value
* @return current instance of CSVParser to allow chained method calls
*/
public CSVPrinter setStrategy(CSVStrategy strategy) {
diff --git a/fork/commons-csv/src/java/org/apache/commons/csv/CSVStrategy.java b/fork/commons-csv/src/java/org/apache/commons/csv/CSVStrategy.java
index 1b04d68b68..aeccd0118f 100644
--- a/fork/commons-csv/src/java/org/apache/commons/csv/CSVStrategy.java
+++ b/fork/commons-csv/src/java/org/apache/commons/csv/CSVStrategy.java
@@ -25,6 +25,7 @@
*/
public class CSVStrategy implements Cloneable, Serializable {
+ private static final long serialVersionUID = -451433279415143890L;
private char delimiter;
private char encapsulator;
private char commentStart;
@@ -59,8 +60,10 @@ public CSVStrategy(char delimiter, char encapsulator, char commentStart) {
* @param delimiter a Char used for value separation
* @param encapsulator a Char used as value encapsulation marker
* @param commentStart a Char used for comment identification
+ * @param escape a char value
* @param ignoreLeadingWhitespace TRUE when leading whitespaces should be
* ignored
+ * @param ignoreTrailingWhitespace a boolean value
* @param interpretUnicodeEscapes TRUE when unicode escapes should be
* interpreted
* @param ignoreEmptyLines TRUE when the parser should skip emtpy lines
@@ -84,8 +87,17 @@ public CSVStrategy(
setUnicodeEscapeInterpretation(interpretUnicodeEscapes);
setIgnoreEmptyLines(ignoreEmptyLines);
}
-
- /** @deprecated */
+ /**
+ * Create a new CSVStrategy instance.
+ *
+ * @param delimiter a char value
+ * @param encapsulator a char value
+ * @param commentStart a char value
+ * @param ignoreLeadingWhitespace a boolean value
+ * @param interpretUnicodeEscapes a boolean value
+ * @param ignoreEmptyLines a boolean value
+ * @deprecated
+ */
public CSVStrategy(
char delimiter,
char encapsulator,
diff --git a/fork/commons-csv/src/java/org/apache/commons/csv/CharBuffer.java b/fork/commons-csv/src/java/org/apache/commons/csv/CharBuffer.java
index c44b2641ff..1dadee8399 100644
--- a/fork/commons-csv/src/java/org/apache/commons/csv/CharBuffer.java
+++ b/fork/commons-csv/src/java/org/apache/commons/csv/CharBuffer.java
@@ -46,6 +46,8 @@ public CharBuffer() {
/**
* Creates a new CharBuffer with an initial capacity
* of length characters.
+ *
+ * @param length an int value
*/
public CharBuffer(final int length) {
if (length == 0) {
@@ -171,7 +173,7 @@ public void trimTrailingWhitespace() {
* modifying it.
* This method allows to avoid copying if the caller knows the exact capacity
* before.
- * @return
+ * @return a char[] value
*/
public char[] getCharacters() {
if (c.length == length) {
@@ -182,9 +184,12 @@ public char[] getCharacters() {
return chars;
}
- /**
- * Returns the character at the specified position.
- */
+ /**
+ * Returns the character at the specified position.
+ *
+ * @param pos an int value
+ * @return a char value
+ */
public char charAt(int pos) {
return c[pos];
}
@@ -192,7 +197,8 @@ public char charAt(int pos) {
/**
* Converts the contents of the buffer into a StringBuffer.
* This method involves copying the new data once!
- * @return
+ *
+ * @return a StringBuffer value
*/
public StringBuffer toStringBuffer() {
StringBuffer sb = new StringBuffer(length);
@@ -203,7 +209,8 @@ public StringBuffer toStringBuffer() {
/**
* Converts the contents of the buffer into a StringBuffer.
* This method involves copying the new data once!
- * @return
+ *
+ * @return a String value
*/
public String toString() {
return new String(c, 0, length);
@@ -211,7 +218,8 @@ public String toString() {
/**
* Copies the data into a new array of at least capacity size.
- * @param capacity
+ *
+ * @param capacity an int value
*/
public void provideCapacity(final int capacity) {
if (c.length >= capacity) {
diff --git a/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVConfig.java b/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVConfig.java
index c1611e0b16..bf1ff5a9b1 100644
--- a/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVConfig.java
+++ b/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVConfig.java
@@ -278,7 +278,8 @@ public boolean isEndTrimmed() {
/**
* Specify if the end of the line needs to be trimmed. Defaults to false.
- * @param endTrimmed
+ *
+ * @param endTrimmed a boolean value
*/
public void setEndTrimmed(boolean endTrimmed) {
this.endTrimmed = endTrimmed;
diff --git a/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVConfigGuesser.java b/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVConfigGuesser.java
index 00c590baa3..d0f6282b29 100644
--- a/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVConfigGuesser.java
+++ b/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVConfigGuesser.java
@@ -115,7 +115,7 @@ protected void analyseLines(String[] lines) {
/**
* Guess if this file is fixedwidth.
* Just basing the fact on all lines being of the same length
- * @param lines
+ * @param lines a String[] value
*/
protected void guessFixedWidth(String[] lines) {
int lastLength = 0;
diff --git a/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVField.java b/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVField.java
index a2f8ee43de..697192ebcd 100644
--- a/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVField.java
+++ b/fork/commons-csv/src/java/org/apache/commons/csv/writer/CSVField.java
@@ -103,7 +103,7 @@ public void setFill(int fill) {
/**
* Does this field override fill ?
*
- * @return
+ * @return a boolean value
*/
public boolean overrideFill() {
return overrideFill;
diff --git a/fork/commons-i18n/pom.xml b/fork/commons-i18n/pom.xml
index 7995ff3078..b77052c291 100644
--- a/fork/commons-i18n/pom.xml
+++ b/fork/commons-i18n/pom.xml
@@ -140,13 +140,6 @@
-
diff --git a/fork/commons-i18n/src/java/org/apache/commons/i18n/JdbcMessageProvider.java b/fork/commons-i18n/src/java/org/apache/commons/i18n/JdbcMessageProvider.java
index b4baaebb10..35157d4038 100644
--- a/fork/commons-i18n/src/java/org/apache/commons/i18n/JdbcMessageProvider.java
+++ b/fork/commons-i18n/src/java/org/apache/commons/i18n/JdbcMessageProvider.java
@@ -21,7 +21,7 @@
* accessible via JDBC. The JdbcMessageProvider only has support for different languages,
* but if support for country or variant is required one could easily subclass it and override the
* getLocale method. If getLocale is overridden, the languageColumn parameter
- * (or jdbc.sql.locale.column Map entry) of the constructors may be null, since it will not be used.
+ * (or jdbc.sql.locale.column Map entry) of the constructors may be null, since it will not be used.
* @author Mattias Jiderhamn
*/
public class JdbcMessageProvider implements MessageProvider {
@@ -86,6 +86,10 @@ public JdbcMessageProvider(DataSource ds, String table, String idColumn, String
* jdbc.sql.table = resources
* jdbc.sql.locale.column = locale
* jdbc.sql.key.column = msgKey
+ *
+ * @param properties a Properties value
+ * @throws ClassNotFoundException if an error occurs constructing the provider
+ * @throws SQLException if an error occurs constructing the provider
*/
public JdbcMessageProvider(Properties properties) throws ClassNotFoundException, SQLException {
String driver = properties.getProperty("jdbc.connect.driver");
@@ -169,7 +173,10 @@ protected String[] getValueColumns(ResultSet rs) throws SQLException {
* by subclasses to allow for proprietary interpretation of language data.
* The default implementation assumes the column with the name provided as languageColumn
* for the constructor contains the ISO-639 code.
+ *
+ * @param rs a ResultSet value
* @return The Locale of the current ResultSet record.
+ * @throws SQLException if an error occurs getting the locale
*/
protected Locale getLocale(ResultSet rs) throws SQLException {
return new Locale(rs.getString(languageColumn).toLowerCase());
diff --git a/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageManager.java b/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageManager.java
index 3bb3c98ef3..a8091f85cb 100644
--- a/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageManager.java
+++ b/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageManager.java
@@ -223,6 +223,11 @@ public static String getText(String providerId, String id, String entry, Object[
* locale. The map contains keys of type {@link String}containing the keys
* of the available message entries and values of type {@link String}
* containing the localized message entries.
+ *
+ * @param id a String value
+ * @param locale a Locale value
+ * @return a Map<String,String> value
+ * @throws MessageNotFoundException if the desired message is not found
*/
public static Map getEntries(String id,
Locale locale)
@@ -242,12 +247,18 @@ public static Map getEntries(String id,
throw exception;
}
- /**
- * Returns a map containing all available message entries for the given
- * locale. The map contains keys of type {@link String}containing the keys
- * of the available message entries and values of type {@link String}
- * containing the localized message entries.
- */
+ /**
+ * Returns a map containing all available message entries for the given
+ * locale. The map contains keys of type {@link String}containing the keys
+ * of the available message entries and values of type {@link String}
+ * containing the localized message entries.
+ *
+ * @param providerId a String value
+ * @param id a String value
+ * @param locale a Locale value
+ * @return a Map<String,String> value
+ * @throws MessageNotFoundException if the desired message is not found
+ */
public static Map getEntries(String providerId,
String id,
Locale locale)
diff --git a/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageNotFoundException.java b/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageNotFoundException.java
index c78d9f3f05..ec0c925163 100644
--- a/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageNotFoundException.java
+++ b/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageNotFoundException.java
@@ -31,6 +31,8 @@
*
*/
public class MessageNotFoundException extends RuntimeException {
+ private static final long serialVersionUID = 9044313257331004814L;
+
/**
* Constructs a new runtime exception with the specified detail message indicating that a particular message
* could not be found.
@@ -54,7 +56,7 @@ public MessageNotFoundException(String message) {
* @param message the detail message (which is saved for later retrieval
* by the {@link #getMessage()} method).
* @param cause the cause (which is saved for later retrieval by the
- * {@link #getCause()} method). (A null value is
+ * {@link #getCause()} method). (A null value is
* permitted, and indicates that the cause is nonexistent or
* unknown.)
*/
diff --git a/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageProvider.java b/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageProvider.java
index 399a82b2d6..65fdaf25da 100644
--- a/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageProvider.java
+++ b/fork/commons-i18n/src/java/org/apache/commons/i18n/MessageProvider.java
@@ -47,7 +47,7 @@ public interface MessageProvider {
/**
* @param id unique id that specifies a particular message
* @param locale the locale for which to return the entries
- * @return returns a map <entry(String) -> localized text(String) of
+ * @return returns a map <entry(String) -> localized text(String) of
* message entries matching the given message id and locale
* @throws MessageNotFoundException thrown if no message could be found matching the given message id
*/
diff --git a/fork/commons-i18n/src/java/org/apache/commons/i18n/ResourceBundleMessageProvider.java b/fork/commons-i18n/src/java/org/apache/commons/i18n/ResourceBundleMessageProvider.java
index 09f46953f5..6d7f3cea54 100644
--- a/fork/commons-i18n/src/java/org/apache/commons/i18n/ResourceBundleMessageProvider.java
+++ b/fork/commons-i18n/src/java/org/apache/commons/i18n/ResourceBundleMessageProvider.java
@@ -65,7 +65,9 @@ public ResourceBundleMessageProvider(String baseName,
}
}
/**
+ * Create a new ResourceBundleMessageProvider instance.
*
+ * @param baseName a String value
* @throws MessageNotFoundException Thrown if the resource bundle does not exist.
*/
public ResourceBundleMessageProvider(String baseName) throws MessageNotFoundException {
diff --git a/fork/commons-i18n/src/test/org/apache/commons/i18n/MessageProviderTestBase.java b/fork/commons-i18n/src/test/org/apache/commons/i18n/MessageProviderTestBase.java
index f8c5926000..0ed424a980 100644
--- a/fork/commons-i18n/src/test/org/apache/commons/i18n/MessageProviderTestBase.java
+++ b/fork/commons-i18n/src/test/org/apache/commons/i18n/MessageProviderTestBase.java
@@ -27,8 +27,8 @@
* If creating new implementations, consider subclassing this class to test the behaviour of that implementation.
* The tests assume the provided MessageProvider
* contains the following entries:
- *
*
+ * Describes entries for the message provider
*
* Language/Locale
* ID
@@ -70,7 +70,6 @@
* This entry is not translated to any other languages
*
*
- *
* Specifically, the ID nonExistentId and the entry nonExistentEntry of ID
* helloWorld must NOT be existent.
*/
@@ -102,7 +101,7 @@ public void tearDown() throws Exception {
/**
* Test functionality of getText() method, which should be common for all implementations of the
* MessageProvider interface.
- * @param messageProvider
+ * @param messageProvider a MessageProvider value
*/
protected void testGetText(MessageProvider messageProvider) {
// Explicit default locale
diff --git a/fork/commons-i18n/src/test/org/apache/commons/i18n/MockProviderTestBase.java b/fork/commons-i18n/src/test/org/apache/commons/i18n/MockProviderTestBase.java
index c983c8b9bd..4d1518fc3c 100644
--- a/fork/commons-i18n/src/test/org/apache/commons/i18n/MockProviderTestBase.java
+++ b/fork/commons-i18n/src/test/org/apache/commons/i18n/MockProviderTestBase.java
@@ -46,6 +46,8 @@ protected void addMockProvider() {
/**
* Add mock provider to MessageManager.
+ *
+ * @param providerId a String value
*/
protected void addMockProvider(final String providerId) {
// Mock message provider that returns a string made up of the arguments passed to it.
diff --git a/fork/commons-i18n/src/test/org/apache/commons/i18n/XMLMessageProviderTest.java b/fork/commons-i18n/src/test/org/apache/commons/i18n/XMLMessageProviderTest.java
index 9d488e5682..b24d70dccf 100644
--- a/fork/commons-i18n/src/test/org/apache/commons/i18n/XMLMessageProviderTest.java
+++ b/fork/commons-i18n/src/test/org/apache/commons/i18n/XMLMessageProviderTest.java
@@ -108,6 +108,8 @@ public void testGetEntries() {
/**
* Constructor for MessageManagerTest.
+ *
+ * @param testName a String value
*/
public XMLMessageProviderTest(String testName) {
super(testName);
diff --git a/marketdata/marketdata-api/src/main/java/org/marketcetera/marketdata/MarketDataClient.java b/marketdata/marketdata-api/src/main/java/org/marketcetera/marketdata/MarketDataClient.java
index b2efae30fd..9ad635b17a 100644
--- a/marketdata/marketdata-api/src/main/java/org/marketcetera/marketdata/MarketDataClient.java
+++ b/marketdata/marketdata-api/src/main/java/org/marketcetera/marketdata/MarketDataClient.java
@@ -53,7 +53,7 @@ Deque getSnapshot(Instrument inInstrument,
/**
* Gets a subset of the most recent snapshot available of the given market data.
*
- * Market data must be pre-requested via {@link #request(ClientContext, MarketDataRequest, boolean)}.
+ *
Market data must be pre-requested via {@link #request(MarketDataRequest, MarketDataListener)}.
*
* @param inInstrument an Instrument value
* @param inContent a Content value
diff --git a/marketdata/marketdata-api/src/main/java/org/marketcetera/marketdata/MarketDataClientFactory.java b/marketdata/marketdata-api/src/main/java/org/marketcetera/marketdata/MarketDataClientFactory.java
index adeff64252..104e529b46 100644
--- a/marketdata/marketdata-api/src/main/java/org/marketcetera/marketdata/MarketDataClientFactory.java
+++ b/marketdata/marketdata-api/src/main/java/org/marketcetera/marketdata/MarketDataClientFactory.java
@@ -16,7 +16,7 @@ public interface MarketDataClientFactory
{
/**
- * Create a {@link MarketDataServiceClient} instance.
+ * Create a {@link MarketDataClient} instance.
*
* @param inParameters a ParameterClazz value
* @return a MarketDataServiceClient value
diff --git a/marketdata/marketdata-core/src/main/java/org/marketcetera/marketdata/AbstractMarketDataModule.java b/marketdata/marketdata-core/src/main/java/org/marketcetera/marketdata/AbstractMarketDataModule.java
index dde7910caa..97fd166af9 100644
--- a/marketdata/marketdata-core/src/main/java/org/marketcetera/marketdata/AbstractMarketDataModule.java
+++ b/marketdata/marketdata-core/src/main/java/org/marketcetera/marketdata/AbstractMarketDataModule.java
@@ -56,6 +56,7 @@
*
* Module Features
*
+ * Indicates the module features
* Capabilities Data Emitter Stops data flows No Start Operation Starts the feed, logs into it. MarketDataFeed value
+ * @return a MarketDataFeed<T,C> value
*/
protected MarketDataFeed getFeed()
{
diff --git a/marketdata/marketdata-core/src/main/java/org/marketcetera/marketdata/MarketDataProviderStatus.java b/marketdata/marketdata-core/src/main/java/org/marketcetera/marketdata/MarketDataProviderStatus.java
index 1bbd342b2e..7c263a4f74 100644
--- a/marketdata/marketdata-core/src/main/java/org/marketcetera/marketdata/MarketDataProviderStatus.java
+++ b/marketdata/marketdata-core/src/main/java/org/marketcetera/marketdata/MarketDataProviderStatus.java
@@ -2,9 +2,6 @@
import java.io.Serializable;
-import org.marketcetera.marketdata.FeedStatus;
-import org.marketcetera.marketdata.MarketDataStatus;
-
/* $License$ */
/**
@@ -36,7 +33,7 @@ public String getProvider()
/**
* Sets the provider value.
*
- * @param a String value
+ * @param inProvider a String value
*/
public void setProvider(String inProvider)
{
diff --git a/marketdata/marketdata-rpc-core/src/test/java/org/marketcetera/marketdata/rpc/MarketDataRpcUtilTest.java b/marketdata/marketdata-rpc-core/src/test/java/org/marketcetera/marketdata/rpc/MarketDataRpcUtilTest.java
index e815bc064a..6d668e0f34 100644
--- a/marketdata/marketdata-rpc-core/src/test/java/org/marketcetera/marketdata/rpc/MarketDataRpcUtilTest.java
+++ b/marketdata/marketdata-rpc-core/src/test/java/org/marketcetera/marketdata/rpc/MarketDataRpcUtilTest.java
@@ -682,7 +682,7 @@ public static void verifyMarketDataEvent(MarketDataTypesRpc.MarketDataEvent inEx
/**
* Verify the given RPC event matches the given event.
*
- * @param inEvent a MarketDataTypesRpc.Event value
+ * @param inExpectedEvent a MarketDataTypesRpc.Event value
* @param inActualEvent an Event value
*/
public static void verifyEvent(MarketDataTypesRpc.Event inExpectedEvent,
diff --git a/marketdata/marketdata-rpc-server/src/test/java/org/marketcetera/marketdata/rpc/MockMarketDataServiceAdapter.java b/marketdata/marketdata-rpc-server/src/test/java/org/marketcetera/marketdata/rpc/MockMarketDataServiceAdapter.java
index 25e83cd4ee..85ef77b37a 100644
--- a/marketdata/marketdata-rpc-server/src/test/java/org/marketcetera/marketdata/rpc/MockMarketDataServiceAdapter.java
+++ b/marketdata/marketdata-rpc-server/src/test/java/org/marketcetera/marketdata/rpc/MockMarketDataServiceAdapter.java
@@ -243,7 +243,7 @@ public void reset()
capabilityRequests.set(0);
}
/**
- * Records requests to {@link MockMarketDataServiceAdapter#getSnapshot(Instrument, Content, String)}.
+ * Records requests to {@link MockMarketDataServiceAdapter#getSnapshot(Instrument, Content)}.
*
* @author Colin DuPlantis
* @version $Id$
diff --git a/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/core/manager/MarketDataManagerModule.java b/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/core/manager/MarketDataManagerModule.java
index a01daf31e0..b790f87cfa 100644
--- a/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/core/manager/MarketDataManagerModule.java
+++ b/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/core/manager/MarketDataManagerModule.java
@@ -40,6 +40,7 @@
*
* Module Features
*
+ * MarketDataManagerModule Capabilites
* Capabilities Data Requester Stops data flows Yes Start Operation None long value
+ * @param inSubscriberTimeout a long value
*/
public void setSubscriberTimeout(long inSubscriberTimeout)
{
diff --git a/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/core/manager/MarketDataManagerModuleFactory.java b/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/core/manager/MarketDataManagerModuleFactory.java
index dc079047a8..90d78967e1 100644
--- a/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/core/manager/MarketDataManagerModuleFactory.java
+++ b/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/core/manager/MarketDataManagerModuleFactory.java
@@ -14,6 +14,7 @@
*
* Module Features
*
+ * MarketDataManagerModuleFactory Capabilities
* Capabilities Data Requester Stops data flows Yes Start Operation None getMarketDataStatusListeners()
/**
* Sets the marketDataStatusListeners value.
*
- * @param a List<MarketDataStatusListener> value
+ * @param inMarketDataStatusListeners a List<MarketDataStatusListener> value
*/
public void setMarketDataStatusListeners(List inMarketDataStatusListeners)
{
@@ -131,7 +131,6 @@ public void setMarketDataStatusListeners(List inMarket
/* (non-Javadoc)
* @see org.marketcetera.marketdata.core.provider.MarketDataStatusProvider#addMarketDataStatusListener(org.marketcetera.marketdata.core.provider.MarketDataStatusListener)
*/
-// @Override
public void addMarketDataStatusListener(MarketDataStatusListener inMarketDataStatusListener)
{
marketDataStatusListeners.add(inMarketDataStatusListener);
@@ -139,7 +138,6 @@ public void addMarketDataStatusListener(MarketDataStatusListener inMarketDataSta
/* (non-Javadoc)
* @see org.marketcetera.marketdata.core.provider.MarketDataStatusProvider#removeMarketDataStatusListener(org.marketcetera.marketdata.core.provider.MarketDataStatusListener)
*/
-// @Override
public void removeMarketDataStatusListener(MarketDataStatusListener inMarketDataStatusListener)
{
marketDataStatusListeners.remove(inMarketDataStatusListener);
@@ -147,7 +145,6 @@ public void removeMarketDataStatusListener(MarketDataStatusListener inMarketData
/* (non-Javadoc)
* @see org.marketcetera.marketdata.core.provider.MarketDataStatusProvider#isRunning()
*/
-// @Override
public boolean isRunning()
{
return lastStatus;
diff --git a/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/service/MarketDataEventModuleConnectorFactory.java b/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/service/MarketDataEventModuleConnectorFactory.java
index b0ec1c26c1..d55a00cb88 100644
--- a/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/service/MarketDataEventModuleConnectorFactory.java
+++ b/marketdata/marketdata-server/src/main/java/org/marketcetera/marketdata/service/MarketDataEventModuleConnectorFactory.java
@@ -12,7 +12,8 @@
* ModuleFactory implementation for the MarketDataEventModuleConnector market data connector.
*
* The factory has the following characteristics.
- *
+ *
+ * MarketDataEventModuleConnectorFactory characteristics
* Provider URN: metc:mdata:connectorCardinality: Singleton Instance URN: metc:mdata:connector:single
* Module Features
*
+ * Describes the module characteristics
* Factory: {@link TestFeedModuleFactory} See {@link AbstractMarketDataModule parent} for module features.
diff --git a/marketdata/marketdata-server/src/test/java/org/marketcetera/marketdata/module/TestFeedModuleFactory.java b/marketdata/marketdata-server/src/test/java/org/marketcetera/marketdata/module/TestFeedModuleFactory.java
index 5ad68c1100..acc8648b36 100644
--- a/marketdata/marketdata-server/src/test/java/org/marketcetera/marketdata/module/TestFeedModuleFactory.java
+++ b/marketdata/marketdata-server/src/test/java/org/marketcetera/marketdata/module/TestFeedModuleFactory.java
@@ -12,13 +12,14 @@
*
* The factory has the following characteristics.
*
+ * Describes the module characteristics
* Provider URN: metc:mdata:feederCardinality: Singleton Instance URN: metc:mdata:bogus:feederAuto-Instantiated: Yes Auto-Started: Yes Instantiation Arguments: None Module Type: {@link FeederModule} Module Type: {@link TestFeedModule}
*
* @author Colin DuPlantis
diff --git a/metrics/metrics-db/src/main/java/org/marketcetera/metrics/dao/PersistentMetric.java b/metrics/metrics-db/src/main/java/org/marketcetera/metrics/dao/PersistentMetric.java
index 9cfc5eed0f..ece8a4904c 100644
--- a/metrics/metrics-db/src/main/java/org/marketcetera/metrics/dao/PersistentMetric.java
+++ b/metrics/metrics-db/src/main/java/org/marketcetera/metrics/dao/PersistentMetric.java
@@ -37,7 +37,7 @@ public String getName()
/**
* Sets the name value.
*
- * @param a String value
+ * @param inName a String value
*/
public void setName(String inName)
{
@@ -55,7 +55,7 @@ public Date getTimestamp()
/**
* Sets the timestamp value.
*
- * @param a Date value
+ * @param inTimestamp a Date value
*/
public void setTimestamp(Date inTimestamp)
{
@@ -73,7 +73,7 @@ public MetricType getType()
/**
* Sets the type value.
*
- * @param a MetricType value
+ * @param inType a MetricType value
*/
public void setType(MetricType inType)
{
@@ -91,7 +91,7 @@ public long getCount()
/**
* Sets the count value.
*
- * @param a long value
+ * @param inCount a long value
*/
public void setCount(long inCount)
{
@@ -127,7 +127,7 @@ public BigDecimal getMean()
/**
* Sets the mean value.
*
- * @param a BigDecimal value
+ * @param inMean a BigDecimal value
*/
public void setMean(BigDecimal inMean)
{
@@ -145,7 +145,7 @@ public BigDecimal getM1()
/**
* Sets the m1 value.
*
- * @param a BigDecimal value
+ * @param inM1 a BigDecimal value
*/
public void setM1(BigDecimal inM1)
{
@@ -163,7 +163,7 @@ public BigDecimal getM5()
/**
* Sets the m5 value.
*
- * @param a BigDecimal value
+ * @param inM5 a BigDecimal value
*/
public void setM5(BigDecimal inM5)
{
@@ -181,7 +181,7 @@ public BigDecimal getM15()
/**
* Sets the m15 value.
*
- * @param a BigDecimal value
+ * @param inM15 a BigDecimal value
*/
public void setM15(BigDecimal inM15)
{
@@ -199,7 +199,7 @@ public BigDecimal getMin()
/**
* Sets the min value.
*
- * @param a BigDecimal value
+ * @param inMin a BigDecimal value
*/
public void setMin(BigDecimal inMin)
{
@@ -217,7 +217,7 @@ public BigDecimal getMax()
/**
* Sets the max value.
*
- * @param a BigDecimal value
+ * @param inMax a BigDecimal value
*/
public void setMax(BigDecimal inMax)
{
@@ -235,7 +235,7 @@ public BigDecimal getStdDev()
/**
* Sets the stdDev value.
*
- * @param a BigDecimal value
+ * @param inStdDev a BigDecimal value
*/
public void setStdDev(BigDecimal inStdDev)
{
@@ -253,7 +253,7 @@ public BigDecimal getMedian()
/**
* Sets the median value.
*
- * @param a BigDecimal value
+ * @param inMedian a BigDecimal value
*/
public void setMedian(BigDecimal inMedian)
{
@@ -271,7 +271,7 @@ public BigDecimal getP75()
/**
* Sets the p75 value.
*
- * @param a BigDecimal value
+ * @param inP75 a BigDecimal value
*/
public void setP75(BigDecimal inP75)
{
@@ -289,7 +289,7 @@ public BigDecimal getP95()
/**
* Sets the p95 value.
*
- * @param a BigDecimal value
+ * @param inP95 a BigDecimal value
*/
public void setP95(BigDecimal inP95)
{
@@ -307,7 +307,7 @@ public BigDecimal getP98()
/**
* Sets the p98 value.
*
- * @param a BigDecimal value
+ * @param inP98 a BigDecimal value
*/
public void setP98(BigDecimal inP98)
{
@@ -325,7 +325,7 @@ public BigDecimal getP99()
/**
* Sets the p99 value.
*
- * @param a BigDecimal value
+ * @param inP99 a BigDecimal value
*/
public void setP99(BigDecimal inP99)
{
@@ -343,7 +343,7 @@ public BigDecimal getP999()
/**
* Sets the p999 value.
*
- * @param a BigDecimal value
+ * @param inP999 a BigDecimal value
*/
public void setP999(BigDecimal inP999)
{
@@ -361,7 +361,7 @@ public BigDecimal getMeanRate()
/**
* Sets the meanRate value.
*
- * @param a BigDecimal value
+ * @param inMeanRate a BigDecimal value
*/
public void setMeanRate(BigDecimal inMeanRate)
{
@@ -379,7 +379,7 @@ public String getRateUnit()
/**
* Sets the rateUnit value.
*
- * @param a String value
+ * @param inRateUnit a String value
*/
public void setRateUnit(String inRateUnit)
{
@@ -397,7 +397,7 @@ public String getDurationUnit()
/**
* Sets the durationUnit value.
*
- * @param a String value
+ * @param inDurationUnit a String value
*/
public void setDurationUnit(String inDurationUnit)
{
@@ -415,7 +415,7 @@ public int getHour()
/**
* Sets the hour value.
*
- * @param an int value
+ * @param inHour an int value
*/
public void setHour(int inHour)
{
@@ -433,7 +433,7 @@ public int getMinute()
/**
* Sets the minute value.
*
- * @param an int value
+ * @param inMinute an int value
*/
public void setMinute(int inMinute)
{
@@ -451,7 +451,7 @@ public int getSecond()
/**
* Sets the second value.
*
- * @param an int value
+ * @param inSecond an int value
*/
public void setSecond(int inSecond)
{
@@ -469,7 +469,7 @@ public int getMillis()
/**
* Sets the millis value.
*
- * @param an int value
+ * @param inMillis an int value
*/
public void setMillis(int inMillis)
{
diff --git a/modules/cep/esper/src/main/java/org/marketcetera/modules/cep/esper/CEPEsperFactory.java b/modules/cep/esper/src/main/java/org/marketcetera/modules/cep/esper/CEPEsperFactory.java
index 909ba7ee21..fa90dab9e2 100644
--- a/modules/cep/esper/src/main/java/org/marketcetera/modules/cep/esper/CEPEsperFactory.java
+++ b/modules/cep/esper/src/main/java/org/marketcetera/modules/cep/esper/CEPEsperFactory.java
@@ -15,7 +15,8 @@
* request and they are auto-started.
*
* The factory has the following characteristics.
- *
+ *
+ * CEPEsperFactory characteristics
* Provider URN: metc:cep:esperCardinality: Multi-Instance Auto-Instantiated: Yes
* Module Features
- *
+ *
+ * CEPEsperProcessor capabilities
* Capabilities Data Emitter, Data Receiver DataFlow Request Parameters String: CEP query; String[]: Multiple CEP queriesStops data flows If it encounters an error when creating statements in external time mode.
* The factory has the following characteristics.
- *
+ *
+ * CEPSystemFactory Characteristics
* Provider URN: metc:cep:systemCardinality: Multi-Instance Auto-Instantiated: Yes
* Module Features
- *
+ *
+ * CEPSystemProcessor Capabilities
* Capabilities Data Emitter, Data Receiver DataFlow Request Parameters String: The CEP queryStops data flows No Module Features
- *
+ *
+ * TensorFlowConverterModule capabilities
* Capabilities Data Emitter, Data Receiver DataFlow Request Parameters none Stops data flows n/a The factory has the following characteristics.
- *
+ *
+ * TensorFlowConverterModuleFactory characteristics
* Provider URN: metc:tensorflow:converterCardinality: Single Instance Auto-Instantiated: Yes The factory has the following characteristics.
- *
+ *
+ * TensorFlowModelModuleFactory characteristics
* Provider URN: metc:tensorflow:modelCardinality: Single Instance Auto-Instantiated: Yes
* Module Features
- *
+ *
+ * Describes the module attributes
* Factory: {@link BogusFeedModuleFactory} See {@link AbstractMarketDataModule parent} for module features.
diff --git a/modules/marketdata/bogus/src/main/java/org/marketcetera/marketdata/bogus/BogusFeedModuleFactory.java b/modules/marketdata/bogus/src/main/java/org/marketcetera/marketdata/bogus/BogusFeedModuleFactory.java
index b446e2d42a..9d5c9b708c 100644
--- a/modules/marketdata/bogus/src/main/java/org/marketcetera/marketdata/bogus/BogusFeedModuleFactory.java
+++ b/modules/marketdata/bogus/src/main/java/org/marketcetera/marketdata/bogus/BogusFeedModuleFactory.java
@@ -21,7 +21,8 @@
* ModuleFactory implementation for the BogusFeed market data provider.
*
* The factory has the following characteristics.
- *
+ *
+ * Describes the module attributes
* Provider URN: metc:mdata:bogusCardinality: Singleton Instance URN: metc:mdata:bogus:singleThe default implementation expects data in the following format:
- *
+ *
+ * BasicCSVFeedEventTranslator data format
* Column0 BID ASK TRADE DIVIDEND STAT Column1 Timestamp Timestamp Timestamp Timestamp Timestamp Column2 Symbol Symbol Symbol Equity Symbol Symbol ModuleFactory implementation for the ExsimFeed market data provider.
*
* The factory has the following characteristics.
- *
+ *
+ * ExsimFeedModuleFactory characteristics
* Provider URN: metc:mdata:exsimCardinality: Singleton Instance URN: metc:mdata:exsim:single
* The factory has the following characteristics.
*
+ * Manual Feed Module Capabilities
* Provider URN: metc:mdata:manualCardinality: Singleton Instance URN: metc:mdata:manual:single
* Module Features
- *
+ *
+ * MarketDataRecorderModule featues
* Capabilities Data Receiver,Data Emitter Stops data flows No Start Operation Checks that the directory exists and is writable
* The factory has the following characteristics.
- *
+ *
+ * MarketDataRecorderModuleFactory characteristics
* Provider URN: metc:mdata:recorderCardinality: Multi-Instance Auto-Instantiated: No
* Module Features
- *
+ *
+ * YahooFeedModule capabilities
* Capabilities Data Emitter Stops data flows No Start Operation Starts the feed, logs into it.
* Module Features
- *
+ *
+ * Describes the module attributes
* Capabilities Data Emitter, Data Reciever DataFlow Request Parameters None. Stops data flows No.
* The factory has the following characteristics.
- *
+ *
+ * Describes the module attributes
* Provider URN: metc:async:simpleCardinality: Multi-Instance Auto-Instantiated: Yes
* Module Features
- *
+ *
+ * Describes the module attributes
* Capabilities Data Emitter DataFlow Request Parameters String, File or URL. Usage explained above. Stops data flows Yes, if there's no more data to emit or if there was an error reading data from the file/URL.
* The factory has the following characteristics.
- *
+ *
+ * Describes the module attributes
* Provider URN: metc:csv:systemCardinality: Singleton InstanceURN: metc:csv:system:singleModule Features
+ *
Module Features
*
+ * Headwater Module Attributes
* Capabilities Data Emitter DataFlow Request Parameters none Stops data flows n/a Start Operation n/a Stop Operation n/a Management Interface n/aManagement Interface n/a Factory {@link HeadwaterModuleFactory}
- *
*
* @author Colin DuPlantis
* @version $Id$
diff --git a/modules/misc/src/main/java/org/marketcetera/modules/headwater/HeadwaterModuleFactory.java b/modules/misc/src/main/java/org/marketcetera/modules/headwater/HeadwaterModuleFactory.java
index 6265c35e79..bbba1dc673 100644
--- a/modules/misc/src/main/java/org/marketcetera/modules/headwater/HeadwaterModuleFactory.java
+++ b/modules/misc/src/main/java/org/marketcetera/modules/headwater/HeadwaterModuleFactory.java
@@ -11,7 +11,8 @@
* Creates {@link HeadwaterModule} objects.
*
* The factory has the following characteristics.
- *
+ *
+ * Headerwater Module Attributes
* Provider URN: metc:misc:headwaterCardinality: Multi-Instance Auto-Instantiated: No Module Features
- *
+ *
+ * Describes the module attributes
* Capabilities Data Emitter, Data Receiver Stops data flows No Start Operation None Colin DuPlantis
* @version $Id$
* @since $Release$
- * @see https://openjfx.io/openjfx-docs/#maven
*/
public class PhotonApp
extends Application
diff --git a/photon/src/main/java/org/marketcetera/ui/admin/view/PermissionView.java b/photon/src/main/java/org/marketcetera/ui/admin/view/PermissionView.java
index 94b054a18f..226eaa8053 100644
--- a/photon/src/main/java/org/marketcetera/ui/admin/view/PermissionView.java
+++ b/photon/src/main/java/org/marketcetera/ui/admin/view/PermissionView.java
@@ -60,7 +60,7 @@ public class PermissionView
* Create a new PermissionView instance.
*
* @param inParentWindow a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
public PermissionView(Region inParentWindow,
diff --git a/photon/src/main/java/org/marketcetera/ui/admin/view/RoleView.java b/photon/src/main/java/org/marketcetera/ui/admin/view/RoleView.java
index 84c0dce5b2..c86c0ca084 100644
--- a/photon/src/main/java/org/marketcetera/ui/admin/view/RoleView.java
+++ b/photon/src/main/java/org/marketcetera/ui/admin/view/RoleView.java
@@ -70,7 +70,7 @@ public class RoleView
* Create a new RoleView instance.
*
* @param inParentWindow a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
public RoleView(Region inParentWindow,
diff --git a/photon/src/main/java/org/marketcetera/ui/admin/view/UserView.java b/photon/src/main/java/org/marketcetera/ui/admin/view/UserView.java
index 63f979d666..995709c6e7 100644
--- a/photon/src/main/java/org/marketcetera/ui/admin/view/UserView.java
+++ b/photon/src/main/java/org/marketcetera/ui/admin/view/UserView.java
@@ -63,7 +63,7 @@ public class UserView
* Create a new UserView instance.
*
* @param inParentWindow a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
public UserView(Region inParentWindow,
diff --git a/photon/src/main/java/org/marketcetera/ui/events/NewWindowEvent.java b/photon/src/main/java/org/marketcetera/ui/events/NewWindowEvent.java
index 1e96e885b5..949dc0f2a7 100644
--- a/photon/src/main/java/org/marketcetera/ui/events/NewWindowEvent.java
+++ b/photon/src/main/java/org/marketcetera/ui/events/NewWindowEvent.java
@@ -20,7 +20,7 @@ public interface NewWindowEvent
/**
* Get the icon to display for the window, if any.
*
- * @return a URL value or null
+ * @return a URL value or null
*/
default URL getWindowIcon()
{
diff --git a/photon/src/main/java/org/marketcetera/ui/fix/view/FixSessionView.java b/photon/src/main/java/org/marketcetera/ui/fix/view/FixSessionView.java
index 3801ee9244..6e44744cfc 100644
--- a/photon/src/main/java/org/marketcetera/ui/fix/view/FixSessionView.java
+++ b/photon/src/main/java/org/marketcetera/ui/fix/view/FixSessionView.java
@@ -155,7 +155,7 @@ public String getViewName()
* Create a new FixSessionView instance.
*
* @param inParent a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inProperties a Properties value
*/
public FixSessionView(Region inParent,
diff --git a/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataDetailView.java b/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataDetailView.java
index 023c00fd6b..7306917711 100644
--- a/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataDetailView.java
+++ b/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataDetailView.java
@@ -169,7 +169,7 @@ protected void onStart()
* Create a new MarketDataDetailView instance.
*
* @param inParent a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inProperties a Properties value
*/
public MarketDataDetailView(Region inParent,
diff --git a/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataItem.java b/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataItem.java
index 680c9207e9..4517f2e657 100644
--- a/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataItem.java
+++ b/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataItem.java
@@ -99,7 +99,7 @@ public ReadOnlyStringProperty tradeExchangeProperty()
/**
* Get the lastPriceProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty lastPriceProperty()
{
@@ -108,7 +108,7 @@ public ReadOnlyObjectProperty lastPriceProperty()
/**
* Get the lastQuantityProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty lastQuantityProperty()
{
@@ -117,7 +117,7 @@ public ReadOnlyObjectProperty lastQuantityProperty()
/**
* Get the tradeTimestampProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<DateTime> value
*/
public ReadOnlyObjectProperty tradeTimestampProperty()
{
@@ -126,7 +126,7 @@ public ReadOnlyObjectProperty tradeTimestampProperty()
/**
* Get the bidTimestampProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<DateTime> value
*/
public ReadOnlyObjectProperty bidTimestampProperty()
{
@@ -135,7 +135,7 @@ public ReadOnlyObjectProperty bidTimestampProperty()
/**
* Get the askTimestampProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<DateTime> value
*/
public ReadOnlyObjectProperty askTimestampProperty()
{
@@ -162,7 +162,7 @@ public ReadOnlyStringProperty askExchangeProperty()
/**
* Get the bidQuantityProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty bidQuantityProperty()
{
@@ -171,7 +171,7 @@ public ReadOnlyObjectProperty bidQuantityProperty()
/**
* Get the bidPriceProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty bidPriceProperty()
{
@@ -180,7 +180,7 @@ public ReadOnlyObjectProperty bidPriceProperty()
/**
* Get the askPriceProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty askPriceProperty()
{
@@ -189,7 +189,7 @@ public ReadOnlyObjectProperty askPriceProperty()
/**
* Get the askQuantityProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty askQuantityProperty()
{
@@ -198,7 +198,7 @@ public ReadOnlyObjectProperty askQuantityProperty()
/**
* Get the previousClosePriceProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty previousClosePriceProperty()
{
@@ -207,7 +207,7 @@ public ReadOnlyObjectProperty previousClosePriceProperty()
/**
* Get the openPriceProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty openPriceProperty()
{
@@ -216,7 +216,7 @@ public ReadOnlyObjectProperty openPriceProperty()
/**
* Get the highPriceProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty highPriceProperty()
{
@@ -225,7 +225,7 @@ public ReadOnlyObjectProperty highPriceProperty()
/**
* Get the lowPriceProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty lowPriceProperty()
{
@@ -234,7 +234,7 @@ public ReadOnlyObjectProperty lowPriceProperty()
/**
* Get the closePriceProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty closePriceProperty()
{
@@ -243,7 +243,7 @@ public ReadOnlyObjectProperty closePriceProperty()
/**
* Get the tradeVolumeProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<BigDecimal> value
*/
public ReadOnlyObjectProperty tradeVolumeProperty()
{
@@ -252,7 +252,7 @@ public ReadOnlyObjectProperty tradeVolumeProperty()
/**
* Get the provider property value.
*
- * @return a ReadOnlyStringProperty,/code> value
+ * @return a ReadOnlyStringProperty value
*/
public ReadOnlyStringProperty providerProperty()
{
diff --git a/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataListView.java b/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataListView.java
index 51d16e0190..8f0bf07187 100644
--- a/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataListView.java
+++ b/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataListView.java
@@ -161,7 +161,7 @@ protected void onClientDisconnect()
* Create a new MarketDataListView instance.
*
* @param inParent a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inProperties a Properties value
*/
public MarketDataListView(Region inParent,
diff --git a/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataQuoteItem.java b/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataQuoteItem.java
index 4bf5d0fa17..56e3939347 100644
--- a/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataQuoteItem.java
+++ b/photon/src/main/java/org/marketcetera/ui/marketdata/view/MarketDataQuoteItem.java
@@ -20,7 +20,7 @@
/* $License$ */
/**
- *
+ * Provides a display implementation of a market data quote.
*
* @author Colin DuPlantis
* @version $Id$
@@ -28,6 +28,11 @@
*/
public class MarketDataQuoteItem
{
+ /**
+ * Create a new MarketDataQuoteItem instance.
+ *
+ * @param inInstrument an Instrument value
+ */
public MarketDataQuoteItem(Instrument inInstrument)
{
instrument = inInstrument;
@@ -40,7 +45,7 @@ public MarketDataQuoteItem(Instrument inInstrument)
/**
* Create a new MarketDataQuoteItem instance.
*
- * @param inQuoteEvent
+ * @param inQuoteEvent a QuoteEvent value
*/
public MarketDataQuoteItem(QuoteEvent inQuoteEvent)
{
@@ -57,7 +62,7 @@ public MarketDataQuoteItem(QuoteEvent inQuoteEvent)
/**
* Get the quoteActionProperty value.
*
- * @return a ObjectProperty value
+ * @return an ObjectProperty<QuoteAction> value
*/
public ObjectProperty quoteActionProperty()
{
@@ -66,7 +71,7 @@ public ObjectProperty quoteActionProperty()
/**
* Get the eventTypeProperty value.
*
- * @return a ObjectProperty value
+ * @return an ObjectProperty<EventType> value
*/
public ObjectProperty eventTypeProperty()
{
@@ -75,7 +80,7 @@ public ObjectProperty eventTypeProperty()
/**
* Get the quoteLevelProperty value.
*
- * @return a IntegerProperty value
+ * @return an IntegerProperty value
*/
public IntegerProperty quoteLevelProperty()
{
@@ -84,7 +89,7 @@ public IntegerProperty quoteLevelProperty()
/**
* Get the quoteCountProperty value.
*
- * @return a IntegerProperty value
+ * @return an IntegerProperty value
*/
public IntegerProperty quoteCountProperty()
{
@@ -102,7 +107,7 @@ public StringProperty symbolProperty()
/**
* Get the timestampProperty value.
*
- * @return a ObjectProperty value
+ * @return an ObjectProperty<DateTime> value
*/
public ObjectProperty timestampProperty()
{
@@ -120,7 +125,7 @@ public StringProperty exchangeProperty()
/**
* Get the quantityProperty value.
*
- * @return a ObjectProperty value
+ * @return an ObjectProperty<BigDecimal> value
*/
public ObjectProperty quantityProperty()
{
@@ -129,12 +134,17 @@ public ObjectProperty quantityProperty()
/**
* Get the priceProperty value.
*
- * @return a ObjectProperty value
+ * @return an ObjectProperty<BigDecimal> value
*/
public ObjectProperty priceProperty()
{
return priceProperty;
}
+ /**
+ * Update the item with the given event.
+ *
+ * @param inEvent an Event value
+ */
public void update(Event inEvent)
{
SLF4JLoggerProxy.trace(this,
@@ -152,14 +162,44 @@ public void update(Event inEvent)
quoteCountProperty.set(quoteEvent.getCount());
}
}
+ /**
+ * quote action property value
+ */
private final ObjectProperty quoteActionProperty = new SimpleObjectProperty<>();
+ /**
+ * event type property value
+ */
private final ObjectProperty eventTypeProperty = new SimpleObjectProperty<>();
+ /**
+ * quote level property value
+ */
private final IntegerProperty quoteLevelProperty = new SimpleIntegerProperty();
+ /**
+ * quote count property value
+ */
private final IntegerProperty quoteCountProperty = new SimpleIntegerProperty();
+ /**
+ * instrument value
+ */
private final Instrument instrument;
+ /**
+ * symbol property
+ */
private final StringProperty symbolProperty;
+ /**
+ * timestamp property
+ */
private final ObjectProperty timestampProperty;
+ /**
+ * exchange property
+ */
private final StringProperty exchangeProperty;
+ /**
+ * quantity property
+ */
private final ObjectProperty quantityProperty;
+ /**
+ * price property
+ */
private final ObjectProperty priceProperty;
}
diff --git a/photon/src/main/java/org/marketcetera/ui/service/SessionUser.java b/photon/src/main/java/org/marketcetera/ui/service/SessionUser.java
index 0b93e7e16b..b2cebc1975 100644
--- a/photon/src/main/java/org/marketcetera/ui/service/SessionUser.java
+++ b/photon/src/main/java/org/marketcetera/ui/service/SessionUser.java
@@ -93,8 +93,8 @@ public Set getPermissions()
*
* The fully qualified name of the type is used as the name when getting the
* value. The outcome of calling this method is thus the same as if
- * callinggetAttribute(type.getName());
*
* @see #setAttribute(Class, Object)
@@ -142,8 +142,7 @@ public Object getAttribute(String name) {
*
* The fully qualified name of the type is used as the name when storing the
* value. The outcome of calling this method is thus the same as if
- * callingsetAttribute(type.getName(), value);
*
* @see #getAttribute(Class)
diff --git a/photon/src/main/java/org/marketcetera/ui/service/StyleService.java b/photon/src/main/java/org/marketcetera/ui/service/StyleService.java
index fa9678cfc7..7063b95f93 100644
--- a/photon/src/main/java/org/marketcetera/ui/service/StyleService.java
+++ b/photon/src/main/java/org/marketcetera/ui/service/StyleService.java
@@ -39,32 +39,42 @@ public void start()
PlatformServices.getServiceName(getClass()));
}
/**
+ * Add styles to the given view.
*
- *
- * @param inContentView
+ * @param inContentView a ContentView value
*/
public void addStyle(ContentView inContentView)
{
// addStyle(inContentView.getScene());
}
/**
+ * Add styles to the given scene.
*
- *
- * @param inContentView
+ * @param inScene a Scene value
*/
- public void addStyle(Scene scene)
+ public void addStyle(Scene inScene)
{
- Parent root = scene.getRoot();
+ Parent root = inScene.getRoot();
for(Node node : root.getChildrenUnmodifiable()) {
addStyle(node);
}
}
- public void addStyleToAll(Node...inComponents)
+ /**
+ * Add styles to the given nodes.
+ *
+ * @param inNodes a Node[] value
+ */
+ public void addStyleToAll(Node...inNodes)
{
- for(Node node : inComponents) {
+ for(Node node : inNodes) {
addStyle(node);
}
}
+ /**
+ * Add style to the given node.
+ *
+ * @param inComponent a Node value
+ */
public void addStyle(Node inComponent)
{
// String componentId = inComponent.getId();
@@ -82,6 +92,13 @@ public void addStyle(Node inComponent)
// componentId,
// inComponent);
}
+ /**
+ * Apply style to the node with the given key.
+ *
+ * @param inIndex an int value
+ * @param inKey a String value
+ * @param inComponent a Node value
+ */
private void applyStyle(int inIndex,
String inKey,
Node inComponent)
diff --git a/photon/src/main/java/org/marketcetera/ui/strategy/service/StrategyClientService.java b/photon/src/main/java/org/marketcetera/ui/strategy/service/StrategyClientService.java
index 5ae0f7568d..de1a701f7c 100644
--- a/photon/src/main/java/org/marketcetera/ui/strategy/service/StrategyClientService.java
+++ b/photon/src/main/java/org/marketcetera/ui/strategy/service/StrategyClientService.java
@@ -132,7 +132,7 @@ public static StrategyClientService getInstance()
* Finds the strategy instance with the given name.
*
* @param inName a String value
- * @returns a java.util.Optional value
+ * @return a java.util.Optional<? extends StrategyInstance> value
*/
public Optional findByName(String inName)
{
@@ -141,7 +141,7 @@ public Optional findByName(String inName)
/**
* Requests loaded strategy instances.
*
- * @returns a Collection<? extends StrategyInstance> value
+ * @return a Collection<? extends StrategyInstance> value
*/
public Collection getStrategyInstances()
{
@@ -153,7 +153,7 @@ public Collection getStrategyInstances()
* @param inStrategyName a String value
* @param inSeverity a Severity value
* @param inPageRequest an PageRequest value
- * @returns a CollectionPageResponse<? extends StrategyMessage> value
+ * @return a CollectionPageResponse<? extends StrategyMessage> value
*/
public CollectionPageResponse getStrategyMessages(String inStrategyName,
Severity inSeverity,
diff --git a/photon/src/main/java/org/marketcetera/ui/strategy/view/DisplayStrategyMessage.java b/photon/src/main/java/org/marketcetera/ui/strategy/view/DisplayStrategyMessage.java
index da151b681e..09f625301f 100644
--- a/photon/src/main/java/org/marketcetera/ui/strategy/view/DisplayStrategyMessage.java
+++ b/photon/src/main/java/org/marketcetera/ui/strategy/view/DisplayStrategyMessage.java
@@ -50,7 +50,7 @@ public ReadOnlyStringProperty strategyNameProperty()
/**
* the timestampProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<DateTime> value
*/
public ReadOnlyObjectProperty timestampProperty()
{
@@ -59,7 +59,7 @@ public ReadOnlyObjectProperty timestampProperty()
/**
* the severityProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<Severity> value
*/
public ReadOnlyObjectProperty severityProperty()
{
diff --git a/photon/src/main/java/org/marketcetera/ui/strategy/view/StrategyView.java b/photon/src/main/java/org/marketcetera/ui/strategy/view/StrategyView.java
index 0680c9593d..4036557b0c 100644
--- a/photon/src/main/java/org/marketcetera/ui/strategy/view/StrategyView.java
+++ b/photon/src/main/java/org/marketcetera/ui/strategy/view/StrategyView.java
@@ -145,7 +145,7 @@ public void changed(ObservableValue inObservable,
filterLayout.setPadding(new Insets(10,10,10,10));
int rowCount = 0;
int colCount = 0;
- filterLayout.add(new Label("Strategy Id"),colCount,rowCount);
+ filterLayout.add(new Label("Strategy Name"),colCount,rowCount);
filterLayout.add(strategyNameComboBox,++colCount,rowCount);
filterLayout.add(new Label("Severity"),++colCount,rowCount);
filterLayout.add(severityComboBox,++colCount,rowCount);
@@ -239,7 +239,7 @@ protected void onClientDisconnect()
* Create a new StrategyView instance.
*
* @param inParent a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inProperties a Properties value
*/
public StrategyView(Region inParent,
@@ -841,10 +841,10 @@ private void initializeStrategyContextMenu()
firstGroup = true;
strategyTableContextMenu.getItems().add(unloadStrategyMenuItem);
}
- if(authzHelperService.hasPermission(StrategyPermissions.CancelStrategyUploadAction)) {
- firstGroup = true;
- strategyTableContextMenu.getItems().add(cancelStrategyUploadMenuItem);
- }
+// if(authzHelperService.hasPermission(StrategyPermissions.CancelStrategyUploadAction)) {
+// firstGroup = true;
+// strategyTableContextMenu.getItems().add(cancelStrategyUploadMenuItem);
+// }
if(authzHelperService.hasPermission(StrategyPermissions.ClearStrategyEventsAction)) {
if(firstGroup) {
strategyTableContextMenu.getItems().add(new SeparatorMenuItem());
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/fixmessagedetails/view/FixMessageDetailsView.java b/photon/src/main/java/org/marketcetera/ui/trade/fixmessagedetails/view/FixMessageDetailsView.java
index e4fd8758f9..80ed59cb13 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/fixmessagedetails/view/FixMessageDetailsView.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/fixmessagedetails/view/FixMessageDetailsView.java
@@ -63,8 +63,8 @@ public Region getMainLayout()
/**
* Create a new FixMessageDetailsView instance.
*
- * @param inParentWindow a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inParent a Region value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
public FixMessageDetailsView(Region inParent,
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/fixmessagedetails/view/FixMessageDetailsViewFactory.java b/photon/src/main/java/org/marketcetera/ui/trade/fixmessagedetails/view/FixMessageDetailsViewFactory.java
index 695472503e..1107bd6c4e 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/fixmessagedetails/view/FixMessageDetailsViewFactory.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/fixmessagedetails/view/FixMessageDetailsViewFactory.java
@@ -7,7 +7,7 @@
/* $License$ */
/**
- * Creates {@link OpenOrderView} content objects.
+ * Creates {@link FixMessageDetailsView} content objects.
*
* @author Colin DuPlantis
* @version $Id$
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/view/AbstractDeletableFixMessageView.java b/photon/src/main/java/org/marketcetera/ui/trade/view/AbstractDeletableFixMessageView.java
index 7024523c04..15b5b30464 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/view/AbstractDeletableFixMessageView.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/view/AbstractDeletableFixMessageView.java
@@ -36,7 +36,7 @@ public abstract class AbstractDeletableFixMessageViewRegion
value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
protected AbstractDeletableFixMessageView(Region inParentWindow,
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/view/AbstractFixMessageView.java b/photon/src/main/java/org/marketcetera/ui/trade/view/AbstractFixMessageView.java
index da98ce00cd..1055800d8a 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/view/AbstractFixMessageView.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/view/AbstractFixMessageView.java
@@ -745,7 +745,7 @@ protected Node getPlaceholder()
* Create a new AbstractFixMessageView instance.
*
* @param inParentWindow a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
protected AbstractFixMessageView(Region inParentWindow,
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/view/averageprice/AveragePriceView.java b/photon/src/main/java/org/marketcetera/ui/trade/view/averageprice/AveragePriceView.java
index 89e8d9314f..b2c61744a5 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/view/averageprice/AveragePriceView.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/view/averageprice/AveragePriceView.java
@@ -31,7 +31,7 @@ public class AveragePriceView
* Create a new AveragePriceView instance.
*
* @param inParentWindow a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
public AveragePriceView(Region inParentWindow,
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/view/fills/FillsView.java b/photon/src/main/java/org/marketcetera/ui/trade/view/fills/FillsView.java
index ec131dd2e4..3dc791aaf2 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/view/fills/FillsView.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/view/fills/FillsView.java
@@ -31,7 +31,7 @@ public class FillsView
* Create a new FillsView instance.
*
* @param inParentWindow a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
public FillsView(Region inParentWindow,
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/view/openorders/OpenOrderView.java b/photon/src/main/java/org/marketcetera/ui/trade/view/openorders/OpenOrderView.java
index adb7487879..be3690bcf2 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/view/openorders/OpenOrderView.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/view/openorders/OpenOrderView.java
@@ -55,7 +55,7 @@ public String getViewName()
* Create a new OpenOrderView instance.
*
* @param inParentWindow a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
public OpenOrderView(Region inParentWindow,
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/view/orderticket/OrderTicketView.java b/photon/src/main/java/org/marketcetera/ui/trade/view/orderticket/OrderTicketView.java
index 8a8be613bb..5458ab3c22 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/view/orderticket/OrderTicketView.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/view/orderticket/OrderTicketView.java
@@ -715,7 +715,7 @@ public void handle(MouseEvent inEvent)
* Create a new OrderTicketView instance.
*
* @param inParent a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inProperties a Properties value
*/
public OrderTicketView(Region inParent,
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/view/reports/ReportsView.java b/photon/src/main/java/org/marketcetera/ui/trade/view/reports/ReportsView.java
index 6eda272006..82c8372daf 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/view/reports/ReportsView.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/view/reports/ReportsView.java
@@ -38,7 +38,7 @@ public class ReportsView
* Create a new ReportsView instance.
*
* @param inParentWindow a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
public ReportsView(Region inParentWindow,
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/view/suggestions/DisplaySuggestion.java b/photon/src/main/java/org/marketcetera/ui/trade/view/suggestions/DisplaySuggestion.java
index 98715c73b4..84dee2d118 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/view/suggestions/DisplaySuggestion.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/view/suggestions/DisplaySuggestion.java
@@ -142,7 +142,7 @@ public ReadOnlyObjectProperty timestampProperty()
/**
* Get the sourceProperty value.
*
- * @return a ReadOnlyObjectProperty value
+ * @return a ReadOnlyObjectProperty<Suggestion> value
*/
public ReadOnlyObjectProperty sourceProperty()
{
diff --git a/photon/src/main/java/org/marketcetera/ui/trade/view/suggestions/SuggestionsView.java b/photon/src/main/java/org/marketcetera/ui/trade/view/suggestions/SuggestionsView.java
index a2630c463f..12d4d970c7 100644
--- a/photon/src/main/java/org/marketcetera/ui/trade/view/suggestions/SuggestionsView.java
+++ b/photon/src/main/java/org/marketcetera/ui/trade/view/suggestions/SuggestionsView.java
@@ -127,7 +127,7 @@ protected void onClientDisconnect()
* Create a new SuggestionsView instance.
*
* @param inParent a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inProperties a Properties value
*/
public SuggestionsView(Region inParent,
diff --git a/photon/src/main/java/org/marketcetera/ui/view/AbstractContentView.java b/photon/src/main/java/org/marketcetera/ui/view/AbstractContentView.java
index de7b9cf43f..4aba26e442 100644
--- a/photon/src/main/java/org/marketcetera/ui/view/AbstractContentView.java
+++ b/photon/src/main/java/org/marketcetera/ui/view/AbstractContentView.java
@@ -174,7 +174,7 @@ protected NewWindowEvent getNewWindowEvent()
* Create a new AbstractContentView instance.
*
* @param inParentWindow a Region value
- * @param inNewWindowEvent a NewWindowEvent value
+ * @param inEvent a NewWindowEvent value
* @param inViewProperties a Properties value
*/
protected AbstractContentView(Region inParentWindow,
diff --git a/pom.xml b/pom.xml
index 88593fec60..ed8c0ef027 100644
--- a/pom.xml
+++ b/pom.xml
@@ -908,6 +908,21 @@
+
+ org.apache.maven.plugins
+ maven-project-info-reports-plugin
+ 3.4.3
+
+
+ org.apache.maven.plugins
+ maven-javadoc-plugin
+ 3.5.0
+
+
+ org.apache.maven.plugins
+ maven-site-plugin
+ 3.12.1
+
org.xolstice.maven.plugins
protobuf-maven-plugin
@@ -1075,18 +1090,6 @@
${mvn.javase.version}
-
-
- maven-javadoc-plugin
- 3.3.2
-
-
- false
-
- -Xdoclint:none
- none
-
-
maven-assembly-plugin
@@ -1181,29 +1184,6 @@
-
- maven-javadoc-plugin
- 3.3.2
-
-
- attach-javadocs
-
- jar
-
-
-
-
- Marketcetera Platform ${project.version} API
- Marketcetera Platform ${project.version} API
- tools/javadoc/overview.html
-
-
-
-
@@ -1266,27 +1246,14 @@
org.apache.maven.plugins
maven-javadoc-plugin
- 3.3.2
-
- org.umlgraph.doclet.UmlGraphDoc
-
- org.umlgraph
- umlgraph
- 5.6.6
-
- -views -all
- true
-
org.apache.maven.plugins
maven-site-plugin
- 3.11.0
org.apache.maven.plugins
maven-project-info-reports-plugin
- 3.2.1
diff --git a/rpc-core/src/main/java/org/marketcetera/rpc/client/AbstractContextAwareRpcClientParameters.java b/rpc-core/src/main/java/org/marketcetera/rpc/client/AbstractContextAwareRpcClientParameters.java
index eb2a4ae0dd..7aff74a509 100644
--- a/rpc-core/src/main/java/org/marketcetera/rpc/client/AbstractContextAwareRpcClientParameters.java
+++ b/rpc-core/src/main/java/org/marketcetera/rpc/client/AbstractContextAwareRpcClientParameters.java
@@ -26,7 +26,7 @@ public ContextClassProvider getContextClassProvider()
/**
* Sets the contextClassProvider value.
*
- * @param a ContextClassProvider value
+ * @param inContextClassProvider a ContextClassProvider value
*/
public void setContextClassProvider(ContextClassProvider inContextClassProvider)
{
diff --git a/rpc-core/src/main/java/org/marketcetera/rpc/paging/PagingRpcUtil.java b/rpc-core/src/main/java/org/marketcetera/rpc/paging/PagingRpcUtil.java
index d969ff7621..1de6a54a0a 100644
--- a/rpc-core/src/main/java/org/marketcetera/rpc/paging/PagingRpcUtil.java
+++ b/rpc-core/src/main/java/org/marketcetera/rpc/paging/PagingRpcUtil.java
@@ -95,7 +95,7 @@ public static PagingRpc.SortOrder getRpcSort(List inSortOrder)
/**
* Set the page response values on the given page response from the given RPC page response.
*
- * @param inPageRequest a ,code>PagingRpc.PageRequest value
+ * @param inPageRequest a PagingRpc.PageRequest value
* @param inPageResponse a PagingRpc.PageResponse value
* @param inResults a CollectionPageResponse<Clazz> value
*/
diff --git a/rpc-core/src/main/java/org/marketcetera/rpc/server/AbstractRpcService.java b/rpc-core/src/main/java/org/marketcetera/rpc/server/AbstractRpcService.java
index 4ab8fe7edb..da7b2b2824 100644
--- a/rpc-core/src/main/java/org/marketcetera/rpc/server/AbstractRpcService.java
+++ b/rpc-core/src/main/java/org/marketcetera/rpc/server/AbstractRpcService.java
@@ -88,7 +88,7 @@ public void setAuthenticator(Authenticator inAuthenticator)
/**
* Get the sessionManager value.
*
- * @return a SessionManager value
+ * @return a SessionManager<SessionClazz> value
*/
public SessionManager getSessionManager()
{
@@ -97,7 +97,7 @@ public SessionManager getSessionManager()
/**
* Sets the sessionManager value.
*
- * @param inSessionManager a SessionManager value
+ * @param inSessionManager a SessionManager<SessionClazz> value
*/
public void setSessionManager(SessionManager inSessionManager)
{
@@ -106,7 +106,7 @@ public void setSessionManager(SessionManager inSessionManager)
/**
* Get the description of the service.
*
- * @return a String value
+ * @return a String value
*/
protected abstract String getServiceDescription();
/**
diff --git a/rpc-core/src/main/java/org/marketcetera/rpc/server/RpcServer.java b/rpc-core/src/main/java/org/marketcetera/rpc/server/RpcServer.java
index 73ece61982..5852a903ca 100644
--- a/rpc-core/src/main/java/org/marketcetera/rpc/server/RpcServer.java
+++ b/rpc-core/src/main/java/org/marketcetera/rpc/server/RpcServer.java
@@ -201,7 +201,7 @@ public void setHostname(String inHostname)
/**
* Get the serverServiceDefinitions value.
*
- * @return a List value
+ * @return a List<BindableService> value
*/
public List getServerServiceDefinitions()
{
@@ -210,7 +210,7 @@ public List getServerServiceDefinitions()
/**
* Sets the serverServiceDefinitions value.
*
- * @param inServerServiceDefinitions a List value
+ * @param inServerServiceDefinitions a List<BindableService> value
*/
public void setServerServiceDefinitions(List inServerServiceDefinitions)
{
diff --git a/rpc-core/src/test/java/org/marketcetera/rpc/RpcTestBase.java b/rpc-core/src/test/java/org/marketcetera/rpc/RpcTestBase.java
index 772abe74de..9c16fa7e05 100644
--- a/rpc-core/src/test/java/org/marketcetera/rpc/RpcTestBase.java
+++ b/rpc-core/src/test/java/org/marketcetera/rpc/RpcTestBase.java
@@ -288,7 +288,7 @@ public Boolean call()
/**
* Get a client factory instance.
*
- * @return a RpcClientFactory<RpcClientParametersClazz,RpcClientClazz&;gt; value
+ * @return a RpcClientFactory<RpcClientParametersClazz,RpcClientClazz> value
*/
protected abstract RpcClientFactory getRpcClientFactory();
/**
@@ -324,7 +324,7 @@ protected abstract RpcClientParametersClazz getClientParameters(String inHostnam
* @param inHostname a String value
* @param inPort an int value
* @param inUsername a String value
- * @param inPassword a String value
+ * @param inPassword a String value
* @return a RpcClientClazz value
* @throws Exception if an unexpected error occurs
*/
diff --git a/strategy/strategy-api/src/main/java/org/marketcetera/strategy/StrategyClient.java b/strategy/strategy-api/src/main/java/org/marketcetera/strategy/StrategyClient.java
index 1919d6d202..8281858ad6 100644
--- a/strategy/strategy-api/src/main/java/org/marketcetera/strategy/StrategyClient.java
+++ b/strategy/strategy-api/src/main/java/org/marketcetera/strategy/StrategyClient.java
@@ -30,14 +30,14 @@ public interface StrategyClient
/**
* Requests loaded strategy instances.
*
- * @returns a Collection<? extends StrategyInstance> value
+ * @return a Collection<? extends StrategyInstance> value
*/
Collection getStrategyInstances();
/**
* Load a new strategy instances.
*
* @param inStrategyInstance a StrategyInstance value
- * @returns an StrategyStatus value
+ * @return an StrategyStatus value
*/
StrategyStatus loadStrategyInstance(StrategyInstance inStrategyInstance);
/**
@@ -46,7 +46,7 @@ public interface StrategyClient
* @param inStrategyName a String value
* @param inSeverity a Severity value
* @param inPageRequest an PageRequest value
- * @returns a CollectionPageResponse<? extends StrategyMessage> value
+ * @return a CollectionPageResponse<? extends StrategyMessage> value
*/
CollectionPageResponse getStrategyMessages(String inStrategyName,
Severity inSeverity,
@@ -55,7 +55,7 @@ CollectionPageResponse getStrategyMessages(String inS
* Finds the strategy instance with the given name.
*
* @param inName a String value
- * @returns an Optional<? extends StrategyInstance> value
+ * @return an Optional<? extends StrategyInstance> value
*/
Optional findByName(String inName);
/**
diff --git a/strategy/strategy-api/src/main/java/org/marketcetera/strategy/StrategyService.java b/strategy/strategy-api/src/main/java/org/marketcetera/strategy/StrategyService.java
index ee0449b958..ea605ef600 100644
--- a/strategy/strategy-api/src/main/java/org/marketcetera/strategy/StrategyService.java
+++ b/strategy/strategy-api/src/main/java/org/marketcetera/strategy/StrategyService.java
@@ -28,7 +28,7 @@ public interface StrategyService
* Requests loaded strategy instances.
*
* @param inCurrentUserName a String value
- * @returns a Collection<StrategyInstance> value
+ * @return a Collection<StrategyInstance> value
*/
Collection getStrategyInstances(String inCurrentUserName);
/**
@@ -37,7 +37,7 @@ public interface StrategyService
* @param inStrategyName a String value
* @param inSeverity a Severity value
* @param inPageRequest an PageRequest value
- * @returns a CollectionPageResponse value
+ * @return a CollectionPageResponse<? extends StrategyMessage> value
*/
CollectionPageResponse getStrategyMessages(String inStrategyName,
Severity inSeverity,
@@ -65,14 +65,14 @@ CollectionPageResponse getStrategyMessages(String inS
* Finds the strategy instance with the given name.
*
* @param inName a String value
- * @returns an Optional value
+ * @return an Optional<? extends StrategyInstance> value
*/
Optional findByName(String inName);
/**
* Load a new strategy instances.
*
* @param inStrategyInstance an StrategyInstance value
- * @returns an StrategyStatus value
+ * @return a StrategyStatus value
*/
StrategyStatus loadStrategyInstance(StrategyInstance inStrategyInstance);
/**
diff --git a/strategy/strategy-core/src/main/java/org/marketcetera/strategy/SimpleStrategyInstanceFactory.java b/strategy/strategy-core/src/main/java/org/marketcetera/strategy/SimpleStrategyInstanceFactory.java
index 3686ec646a..5b2fc3bf57 100644
--- a/strategy/strategy-core/src/main/java/org/marketcetera/strategy/SimpleStrategyInstanceFactory.java
+++ b/strategy/strategy-core/src/main/java/org/marketcetera/strategy/SimpleStrategyInstanceFactory.java
@@ -3,6 +3,8 @@
//
package org.marketcetera.strategy;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,6 +14,7 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class SimpleStrategyInstanceFactory
implements org.marketcetera.strategy.StrategyInstanceFactory
{
@@ -28,7 +31,7 @@ public org.marketcetera.strategy.SimpleStrategyInstance create()
/**
* Create a new org.marketcetera.strategy.SimpleStrategyInstance instance from the given object.
*
- * @param inStrategyInstance an org.marketcetera.strategy.SimpleStrategyInstance value
+ * @param inSimpleStrategyInstance an org.marketcetera.strategy.SimpleStrategyInstance value
* @return an org.marketcetera.strategy.SimpleStrategyInstance value
*/
@Override
diff --git a/strategy/strategy-core/src/main/java/org/marketcetera/strategy/SimpleStrategyMessageFactory.java b/strategy/strategy-core/src/main/java/org/marketcetera/strategy/SimpleStrategyMessageFactory.java
index 7c69d33bce..eee8a1db51 100644
--- a/strategy/strategy-core/src/main/java/org/marketcetera/strategy/SimpleStrategyMessageFactory.java
+++ b/strategy/strategy-core/src/main/java/org/marketcetera/strategy/SimpleStrategyMessageFactory.java
@@ -3,6 +3,8 @@
//
package org.marketcetera.strategy;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,6 +14,7 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class SimpleStrategyMessageFactory
implements org.marketcetera.strategy.StrategyMessageFactory
{
@@ -32,8 +35,8 @@ public org.marketcetera.strategy.SimpleStrategyMessage create()
* @return an org.marketcetera.strategy.SimpleStrategyMessage value
*/
@Override
- public org.marketcetera.strategy.SimpleStrategyMessage create(org.marketcetera.strategy.StrategyMessage inSimpleStrategyMessage)
+ public org.marketcetera.strategy.SimpleStrategyMessage create(org.marketcetera.strategy.StrategyMessage inStrategyMessage)
{
- return new org.marketcetera.strategy.SimpleStrategyMessage(inSimpleStrategyMessage);
+ return new org.marketcetera.strategy.SimpleStrategyMessage(inStrategyMessage);
}
}
diff --git a/strategy/strategy-rpc-core/src/main/java/org/marketcetera/strategy/StrategyRpcUtil.java b/strategy/strategy-rpc-core/src/main/java/org/marketcetera/strategy/StrategyRpcUtil.java
index 35eae5e2a6..61614ed2c8 100644
--- a/strategy/strategy-rpc-core/src/main/java/org/marketcetera/strategy/StrategyRpcUtil.java
+++ b/strategy/strategy-rpc-core/src/main/java/org/marketcetera/strategy/StrategyRpcUtil.java
@@ -169,7 +169,7 @@ public static Optional getStrategyInstance(StrategyTypesRpc.St
/**
* Get the object from the given RPC value.
*
- * @param inSeverityan StrategyTypesRpc.StrategyMessageSeverity value
+ * @param inSeverity an StrategyTypesRpc.StrategyMessageSeverity value
* @return an Optional<INotification.Severity> value
*/
public static Optional getStrategyMessageSeverity(StrategyTypesRpc.StrategyMessageSeverity inSeverity)
diff --git a/strategy/strategy-sample/src/main/java/org/marketcetera/strategy/sample/TestStrategy.java b/strategy/strategy-sample/src/main/java/org/marketcetera/strategy/sample/TestStrategy.java
index d43a1de737..57209b675d 100644
--- a/strategy/strategy-sample/src/main/java/org/marketcetera/strategy/sample/TestStrategy.java
+++ b/strategy/strategy-sample/src/main/java/org/marketcetera/strategy/sample/TestStrategy.java
@@ -188,5 +188,4 @@ public MarketDataCacheElement load(Instrument inKey)
*/
@Autowired
private TradeClient tradeClient;
-
}
diff --git a/strategy/strategy-server/src/main/java/org/marketcetera/strategy/StrategyServiceImpl.java b/strategy/strategy-server/src/main/java/org/marketcetera/strategy/StrategyServiceImpl.java
index 6fd84dea0c..e806de29e4 100644
--- a/strategy/strategy-server/src/main/java/org/marketcetera/strategy/StrategyServiceImpl.java
+++ b/strategy/strategy-server/src/main/java/org/marketcetera/strategy/StrategyServiceImpl.java
@@ -173,7 +173,7 @@ public void stop()
/**
* Requests loaded strategy instances.
*
- * @returns a Collection value
+ * @return a Collection<StrategyInstance> value
*/
@Override
@Transactional(readOnly=true,propagation=Propagation.REQUIRED)
@@ -188,8 +188,8 @@ public Collection getStrategyInstances(String inCurr
*
* @param inStrategyName a String value
* @param inSeverity a Severity value
- * @param inPageRequest an PageRequest value
- * @returns a CollectionPageResut value
+ * @param inPageRequest a PageRequest value
+ * @return a CollectionPageResponse<? extends StrategyMessage> value
*/
@Override
@Transactional(readOnly=true,propagation=Propagation.REQUIRED)
@@ -451,8 +451,8 @@ public Path getTemporaryStrategyDirectory()
/**
* Load a new strategy instances.
*
- * @param inStrategyInstance an StrategyInstance value
- * @returns an StrategyStatus value
+ * @param inFile a File value
+ * @param inOriginalFileName a String value
*/
@Override
@Transactional(readOnly=false,propagation=Propagation.REQUIRED)
@@ -514,7 +514,7 @@ public void received(File inFile,
* Load a new strategy instances.
*
* @param inStrategyInstance an StrategyInstance value
- * @returns an StrategyStatus value
+ * @return a StrategyStatus value
*/
@Override
@Transactional(readOnly=false,propagation=Propagation.REQUIRED)
@@ -588,7 +588,7 @@ public void removeStrategyEventListener(StrategyEventListener inListener)
* Finds the strategy instance with the given name.
*
* @param inName a String value
- * @returns a Optional value
+ * @return a Optional<? extends StrategyInstance> value
*/
@Override
@Transactional(readOnly=true,propagation=Propagation.REQUIRED)
diff --git a/strategy/strategy-server/src/main/java/org/marketcetera/strategy/dao/PersistentStrategyInstanceFactory.java b/strategy/strategy-server/src/main/java/org/marketcetera/strategy/dao/PersistentStrategyInstanceFactory.java
index 675938d78a..09ddb7fa43 100644
--- a/strategy/strategy-server/src/main/java/org/marketcetera/strategy/dao/PersistentStrategyInstanceFactory.java
+++ b/strategy/strategy-server/src/main/java/org/marketcetera/strategy/dao/PersistentStrategyInstanceFactory.java
@@ -3,6 +3,8 @@
//
package org.marketcetera.strategy.dao;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,6 +14,7 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class PersistentStrategyInstanceFactory
implements org.marketcetera.strategy.StrategyInstanceFactory
{
@@ -32,8 +35,8 @@ public org.marketcetera.strategy.dao.PersistentStrategyInstance create()
* @return an org.marketcetera.strategy.dao.PersistentStrategyInstance value
*/
@Override
- public org.marketcetera.strategy.dao.PersistentStrategyInstance create(org.marketcetera.strategy.StrategyInstance inPersistentStrategyInstance)
+ public org.marketcetera.strategy.dao.PersistentStrategyInstance create(org.marketcetera.strategy.StrategyInstance inStrategyInstance)
{
- return new org.marketcetera.strategy.dao.PersistentStrategyInstance(inPersistentStrategyInstance);
+ return new org.marketcetera.strategy.dao.PersistentStrategyInstance(inStrategyInstance);
}
}
diff --git a/strategy/strategy-server/src/main/java/org/marketcetera/strategy/dao/PersistentStrategyMessageFactory.java b/strategy/strategy-server/src/main/java/org/marketcetera/strategy/dao/PersistentStrategyMessageFactory.java
index 361c4f2dcf..0a5716d202 100644
--- a/strategy/strategy-server/src/main/java/org/marketcetera/strategy/dao/PersistentStrategyMessageFactory.java
+++ b/strategy/strategy-server/src/main/java/org/marketcetera/strategy/dao/PersistentStrategyMessageFactory.java
@@ -3,6 +3,10 @@
//
package org.marketcetera.strategy.dao;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.strategy.StrategyMessage;
+import org.marketcetera.strategy.StrategyMessageFactory;
+
/* $License$ */
/**
@@ -12,28 +16,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class PersistentStrategyMessageFactory
- implements org.marketcetera.strategy.StrategyMessageFactory
+ implements StrategyMessageFactory
{
/**
- * Create a new org.marketcetera.strategy.dao.PersistentStrategyMessage instance.
+ * Create a new PersistentStrategyMessage instance.
*
- * @return a org.marketcetera.strategy.dao.PersistentStrategyMessage value
+ * @return a PersistentStrategyMessage value
*/
@Override
- public org.marketcetera.strategy.dao.PersistentStrategyMessage create()
+ public PersistentStrategyMessage create()
{
- return new org.marketcetera.strategy.dao.PersistentStrategyMessage();
+ return new PersistentStrategyMessage();
}
/**
- * Create a new org.marketcetera.strategy.dao.PersistentStrategyMessage instance from the given object.
+ * Create a new PersistentStrategyMessage instance from the given object.
*
- * @param inStrategyMessage an org.marketcetera.strategy.dao.PersistentStrategyMessage value
- * @return an org.marketcetera.strategy.dao.PersistentStrategyMessage value
+ * @param inStrategyMessage an PersistentStrategyMessage value
+ * @return a PersistentStrategyMessage value
*/
@Override
- public org.marketcetera.strategy.dao.PersistentStrategyMessage create(org.marketcetera.strategy.StrategyMessage inPersistentStrategyMessage)
+ public PersistentStrategyMessage create(StrategyMessage inStrategyMessage)
{
- return new org.marketcetera.strategy.dao.PersistentStrategyMessage(inPersistentStrategyMessage);
+ return new PersistentStrategyMessage(inStrategyMessage);
}
}
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/client/TradeClient.java b/trade/trade-api/src/main/java/org/marketcetera/trade/client/TradeClient.java
index f8c654c84d..c68f9d928b 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/client/TradeClient.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/client/TradeClient.java
@@ -98,7 +98,7 @@ BigDecimal getPositionAsOf(Date inDate,
* Returns all positions of options with the given root symbols based on reports generated and received on or before the supplied date in UTC.
*
* @param inDate a Date value
- * @param inRootElements a String[] value
+ * @param inRootSymbols a String[] value
* @return a Map<PositionKey<Optiont>,BigDecimal> value
*/
Map,BigDecimal> getOptionPositionsAsOf(Date inDate,
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/CurrentPositionFactory.java b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/CurrentPositionFactory.java
index 5d282e69a7..9cb5c1e69f 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/CurrentPositionFactory.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/CurrentPositionFactory.java
@@ -3,6 +3,9 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Factory;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,8 +15,9 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public interface CurrentPositionFactory
- extends org.marketcetera.core.Factory
+ extends Factory
{
/**
* Create a new CurrentPosition instance.
@@ -25,7 +29,7 @@ public interface CurrentPositionFactory
/**
* Create a new CurrentPosition instance from the given object.
*
- * @param inObject a CurrentPosition value
+ * @param inCurrentPosition a CurrentPosition value
* @return a CurrentPosition value
*/
@Override
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/LotFactory.java b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/LotFactory.java
index 9f84d04d03..9b15496856 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/LotFactory.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/LotFactory.java
@@ -3,6 +3,9 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Factory;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,8 +15,9 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public interface LotFactory
- extends org.marketcetera.core.Factory
+ extends Factory
{
/**
* Create a new Lot instance.
@@ -25,7 +29,7 @@ public interface LotFactory
/**
* Create a new Lot instance from the given object.
*
- * @param inObject a Lot value
+ * @param inLot a Lot value
* @return a Lot value
*/
@Override
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/PositionFactory.java b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/PositionFactory.java
index 74701e33f4..7e87d20955 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/PositionFactory.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/PositionFactory.java
@@ -3,6 +3,9 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Factory;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,8 +15,9 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public interface PositionFactory
- extends org.marketcetera.core.Factory
+ extends Factory
{
/**
* Create a new Position instance.
@@ -25,7 +29,7 @@ public interface PositionFactory
/**
* Create a new Position instance from the given object.
*
- * @param inObject a Position value
+ * @param inPosition a Position value
* @return a Position value
*/
@Override
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/ProfitAndLossFactory.java b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/ProfitAndLossFactory.java
index 1ff745ee4f..3fcca6cf5b 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/ProfitAndLossFactory.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/ProfitAndLossFactory.java
@@ -3,6 +3,9 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Factory;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,8 +15,9 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public interface ProfitAndLossFactory
- extends org.marketcetera.core.Factory
+ extends Factory
{
/**
* Create a new ProfitAndLoss instance.
@@ -25,7 +29,7 @@ public interface ProfitAndLossFactory
/**
* Create a new ProfitAndLoss instance from the given object.
*
- * @param inObject a ProfitAndLoss value
+ * @param inProfitAndLoss a ProfitAndLoss value
* @return a ProfitAndLoss value
*/
@Override
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradeFactory.java b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradeFactory.java
index 1f3adbd144..55422d9988 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradeFactory.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradeFactory.java
@@ -3,6 +3,9 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Factory;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,8 +15,9 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public interface TradeFactory
- extends org.marketcetera.core.Factory
+ extends Factory
{
/**
* Create a new Trade instance.
@@ -25,7 +29,7 @@ public interface TradeFactory
/**
* Create a new Trade instance from the given object.
*
- * @param inObject a Trade value
+ * @param inTrade a Trade value
* @return a Trade value
*/
@Override
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradePnlClient.java b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradePnlClient.java
index b2061529d5..2b0d836d7f 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradePnlClient.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradePnlClient.java
@@ -3,6 +3,11 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.persist.PageRequest;
+import org.marketcetera.trade.Instrument;
+import org.marketcetera.trade.UserID;
+
/* $License$ */
/**
@@ -12,24 +17,28 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public interface TradePnlClient
extends org.marketcetera.core.BaseClient
{
/**
* Requests positions for a user.
*
- * @param inUserID a org.marketcetera.trade.UserID value
- * @param inPageRequest a org.marketcetera.persist.PageRequest value
- * @returns a org.marketcetera.trade.pnl.CurrentPosition value
+ * @param inUserID a UserID value
+ * @param inPageRequest a PageRequest value
+ * @return a CurrentPosition value
*/
- org.marketcetera.trade.pnl.CurrentPosition getCurrentPositions(org.marketcetera.trade.UserID inUserID,org.marketcetera.persist.PageRequest inPageRequest);
+ CurrentPosition getCurrentPositions(UserID inUserID,
+ PageRequest inPageRequest);
/**
* Requests profit and loss for a user and an instrument.
*
- * @param inUserID a org.marketcetera.trade.UserID value
- * @param inInstrument a org.marketcetera.trade.Instrument value
- * @param inPageRequest a org.marketcetera.persist.PageRequest value
- * @returns a org.marketcetera.trade.pnl.ProfitAndLoss value
+ * @param inUserID a UserID value
+ * @param inInstrument a Instrument value
+ * @param inPageRequest a PageRequest value
+ * @return a ProfitAndLoss value
*/
- org.marketcetera.trade.pnl.ProfitAndLoss getProfitAndLoss(org.marketcetera.trade.UserID inUserID,org.marketcetera.trade.Instrument inInstrument,org.marketcetera.persist.PageRequest inPageRequest);
+ ProfitAndLoss getProfitAndLoss(UserID inUserID,
+ Instrument inInstrument,
+ PageRequest inPageRequest);
}
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradePnlService.java b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradePnlService.java
index ca7c474fa3..2564aa4804 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradePnlService.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/TradePnlService.java
@@ -3,6 +3,12 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.persist.CollectionPageResponse;
+import org.marketcetera.persist.PageRequest;
+import org.marketcetera.trade.Instrument;
+import org.marketcetera.trade.UserID;
+
/* $License$ */
/**
@@ -12,23 +18,27 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public interface TradePnlService
{
/**
* Requests positions for a user.
*
- * @param inUserID a org.marketcetera.trade.UserID value
- * @param inPageRequest a org.marketcetera.persist.PageRequest value
- * @returns a org.marketcetera.trade.pnl.CurrentPosition value
+ * @param inUserID a UserID value
+ * @param inPageRequest a PageRequest value
+ * @return a CollectionPageResponse<CurrentPosition> value
*/
- org.marketcetera.persist.CollectionPageResponse getCurrentPositions(org.marketcetera.trade.UserID inUserID,org.marketcetera.persist.PageRequest inPageRequest);
+ CollectionPageResponse getCurrentPositions(UserID inUserID,
+ PageRequest inPageRequest);
/**
* Requests profit and loss for a user and an instrument.
*
- * @param inUserID a org.marketcetera.trade.UserID value
- * @param inInstrument a org.marketcetera.trade.Instrument value
- * @param inPageRequest a org.marketcetera.persist.PageRequest value
- * @returns a org.marketcetera.trade.pnl.ProfitAndLoss value
+ * @param inUserID a UserID value
+ * @param inInstrument a Instrument value
+ * @param inPageRequest a PageRequest value
+ * @return a CollectionPageResponse<ProfitAndLoss> value
*/
- org.marketcetera.persist.CollectionPageResponse getProfitAndLoss(org.marketcetera.trade.UserID inUserID,org.marketcetera.trade.Instrument inInstrument,org.marketcetera.persist.PageRequest inPageRequest);
+ CollectionPageResponse getProfitAndLoss(UserID inUserID,
+ Instrument inInstrument,
+ PageRequest inPageRequest);
}
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/UserTradeFactory.java b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/UserTradeFactory.java
index 8d22e9c9f0..b229ef1382 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/UserTradeFactory.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/pnl/UserTradeFactory.java
@@ -3,6 +3,9 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Factory;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,8 +15,9 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public interface UserTradeFactory
- extends org.marketcetera.core.Factory
+ extends Factory
{
/**
* Create a new UserTrade instance.
@@ -25,7 +29,7 @@ public interface UserTradeFactory
/**
* Create a new UserTrade instance from the given object.
*
- * @param inObject a UserTrade value
+ * @param inUserTrade a UserTrade value
* @return a UserTrade value
*/
@Override
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/service/ReportService.java b/trade/trade-api/src/main/java/org/marketcetera/trade/service/ReportService.java
index 74d7b0de66..daa5e88012 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/service/ReportService.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/service/ReportService.java
@@ -325,7 +325,7 @@ Page getExecutions(int inPageNumber,
*
* @param inMessage a HasFIXMessage value
* @param inBrokerID a BrokerID value
- * @param inUserID a UserID value
+ * @param inUserId a UserID value
*/
void addReport(HasFIXMessage inMessage,
BrokerID inBrokerID,
diff --git a/trade/trade-api/src/main/java/org/marketcetera/trade/service/TradeService.java b/trade/trade-api/src/main/java/org/marketcetera/trade/service/TradeService.java
index b543682d53..319fdcfd43 100644
--- a/trade/trade-api/src/main/java/org/marketcetera/trade/service/TradeService.java
+++ b/trade/trade-api/src/main/java/org/marketcetera/trade/service/TradeService.java
@@ -28,7 +28,6 @@ public interface TradeService
*
* @param inOrder an Order value
* @return a ServerFixSession value
- * @throws NoBrokerSelected if a session could not be determined
*/
ServerFixSession selectServerFixSession(Order inOrder);
/**
@@ -37,8 +36,6 @@ public interface TradeService
* @param inOrder an Order value
* @param inServerFixSession a ServerFixSession value
* @return a quickfix.Message value
- * @throws BrokerUnavailable if the broker is unavailable or unknown
- * @throws MessageIntercepted if the order should not be sent on in the data flow
*/
quickfix.Message convertOrder(Order inOrder,
ServerFixSession inServerFixSession);
diff --git a/trade/trade-core/src/main/java/org/marketcetera/client/instruments/CurrencyValidationHandler.java b/trade/trade-core/src/main/java/org/marketcetera/client/instruments/CurrencyValidationHandler.java
index 427ebf923d..7324d57286 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/client/instruments/CurrencyValidationHandler.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/client/instruments/CurrencyValidationHandler.java
@@ -11,8 +11,6 @@
/**
* A class that perform currency validation functions.
*
- * @param The type of instrument handled by this function
- *
*/
@ClassVersion("$Id: CurrencyValidationHandler")
public class CurrencyValidationHandler extends InstrumentValidationHandler{
diff --git a/trade/trade-core/src/main/java/org/marketcetera/client/instruments/OptionValidationHandler.java b/trade/trade-core/src/main/java/org/marketcetera/client/instruments/OptionValidationHandler.java
index e5e35e03ab..0f57d4ba82 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/client/instruments/OptionValidationHandler.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/client/instruments/OptionValidationHandler.java
@@ -47,13 +47,10 @@ public void validate(Instrument instrument) throws OrderValidationException {
*
* where:
*
- * YYYY: represents the year
- * YYYY: represents the year
+ * MM: represents the month: 01-12
+ * DD: represents the day of the month: 01-31
+ * wN: represents the week number: w1-w5
*
*
* @param inExpiry the expiry field of the option
diff --git a/trade/trade-core/src/main/java/org/marketcetera/client/utils/AutoOrderHistoryManager.java b/trade/trade-core/src/main/java/org/marketcetera/client/utils/AutoOrderHistoryManager.java
index 1699b00a92..491d6b508d 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/client/utils/AutoOrderHistoryManager.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/client/utils/AutoOrderHistoryManager.java
@@ -2,7 +2,6 @@
import java.util.Date;
-import org.marketcetera.trade.ReportBase;
import org.marketcetera.trade.TradeMessage;
import org.marketcetera.trade.TradeMessageListener;
import org.marketcetera.trade.utils.OrderHistoryManager;
@@ -18,7 +17,7 @@
* to look for order history.
*
* This class will receive new reports on its own - it is not necessary nor is it permitted to manually
- * {@link #add(ReportBase) add reports}.
+ * {@link #add(TradeMessage) add reports}.
*
*
Note that there are significant performance and resource implications when using this class.
* Depending on historical order volume, this class may be required to process thousands or millions
diff --git a/trade/trade-core/src/main/java/org/marketcetera/core/instruments/InstrumentFromMessage.java b/trade/trade-core/src/main/java/org/marketcetera/core/instruments/InstrumentFromMessage.java
index f6dcb70771..40b82269d4 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/core/instruments/InstrumentFromMessage.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/core/instruments/InstrumentFromMessage.java
@@ -13,10 +13,7 @@
* from a FIX message.
*
* Typical usage is
- *
- * quickfix.Message message =...
- * {@link InstrumentFromMessage}.{@link #SELECTOR}.{@link DynamicInstrumentFunctionSelector#forValue(Object) forValue}(message).{@link #extract(quickfix.Message) extract}(message);
- *
+ * Instrument instrument = InstrumentFromMessage.SELECTOR.forValue(quickfix.Message).extract(quickfix.Message);
*
* @author anshul@marketcetera.com
* @version $Id$
diff --git a/trade/trade-core/src/main/java/org/marketcetera/core/instruments/InstrumentToMessage.java b/trade/trade-core/src/main/java/org/marketcetera/core/instruments/InstrumentToMessage.java
index 05ebb567be..26163a953f 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/core/instruments/InstrumentToMessage.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/core/instruments/InstrumentToMessage.java
@@ -6,7 +6,6 @@
import quickfix.DataDictionary;
import quickfix.FieldMap;
-import quickfix.Message;
import quickfix.field.SecurityType;
import quickfix.field.Symbol;
@@ -16,16 +15,7 @@
* instrument onto the supplied FIX message.
*
* Typical usage is:
- *
- * Instrument instrument = ...
- * quickfix.DataDictionary dataDictionary = ...
- * String msgType = ...
- * quickfix.Message message = ...
- * InstrumentToMessage itm = {@link InstrumentToMessage}.{@link #SELECTOR}.{@link StaticInstrumentFunctionSelector#forInstrument(Instrument) forInstrument}(instrument);
- * if(itm.{@link #isSupported(quickfix.DataDictionary, String) isSupported}(dataDictionary,msgType)) {
- * itm.{@link #set(Instrument, DataDictionary, String, Message) set}(instrument, dataDictionary, msgType, message);
- * }
- *
+ * InstrumentToMessage.SELECTOR.forInstrument(instrument).set(instrument,mMessageFactory.getBeginString(),quickfixMessage);
*
* @param The type of instrument handled by this function
*
@@ -45,7 +35,7 @@ public abstract class InstrumentToMessage extends Instrume
*
* NOTE: This method is only meant to be used for unit testing.
* It's not recommended that this method be used in production. Use
- * {@link #set(org.marketcetera.trade.Instrument,quickfix.DataDictionary, String,quickfix.Message)} instead.
+ * {@link #set(Instrument, String, quickfix.FieldMap)} instead.
*
* @param inInstrument the instrument
* @param inBeginString the begin string value of the FIX message
diff --git a/trade/trade-core/src/main/java/org/marketcetera/core/instruments/package-info.java b/trade/trade-core/src/main/java/org/marketcetera/core/instruments/package-info.java
deleted file mode 100644
index 670dfa9479..0000000000
--- a/trade/trade-core/src/main/java/org/marketcetera/core/instruments/package-info.java
+++ /dev/null
@@ -1,63 +0,0 @@
-/* $License$ */
-/**
- * Provides mechanisms to abstract out instrument specific functionality in
- * the system.
- *
- * Two types of abstractions are available.
- *
- * {@link org.marketcetera.core.instruments.InstrumentFunctionHandler}: For carrying out instrument
- * specific functions when an instrument instance is available.
- * {@link org.marketcetera.core.instruments.DynamicInstrumentHandler}: For carrying out
- * instrument specific functions when an instrument instance is not available
- * but some other data is available from which the instrument type can be
- * determined.
- *
- * InstrumentFunctionHandler
- *
- * Any instrument specific functionality that needs to be performed when an
- * instrument instance is available is abstracted out by
- * implementing it in a subclass of
- * {@link org.marketcetera.core.instruments.InstrumentFunctionHandler}.
- *
- * A {@link org.marketcetera.core.instruments.StaticInstrumentFunctionSelector}
- * instance can be used to dynamically select the appropriate handler
- * instance for an instrument via
- * {@link org.marketcetera.core.instruments.StaticInstrumentFunctionSelector#forInstrument(org.marketcetera.trade.Instrument)}.
- * The selector chooses the appropriate instrument specific subclass of
- * {@link org.marketcetera.core.instruments.StaticInstrumentFunctionSelector}
- * based on the runtime type of the instrument.
- *
- * See {@link org.marketcetera.core.instruments.InstrumentToMessage} for an
- * example.
- *
- *
DynamicInstrumentHandler
- * In cases when an instrument instance is not available and instrument
- * specific functionality needs to be invoked based on an arbitrary data,
- * a combination of {@link org.marketcetera.core.instruments.DynamicInstrumentFunctionSelector}
- * & {@link org.marketcetera.core.instruments.DynamicInstrumentHandler} is
- * used. These classes help dynamically select the instrument specific
- * functionality in absence of the Instrument object. See
- * {@link org.marketcetera.core.instruments.InstrumentFromMessage}
- * for an example.
- * Available Handlers
- * The following handlers are available for extraction and insertion of
- * instruments from / in to FIX messages.
- *
- * {@link org.marketcetera.core.instruments.InstrumentToMessage}:
- * Sets the fields corresponding to an instrument on a FIX message
- * {@link org.marketcetera.core.instruments.InstrumentFromMessage}:
- * Extracts an instrument from a FIX message
- *
- * packaging
- * The {@link java.util.ServiceLoader} class is used to dynamically
- * discover and load instrument specific functions. A
- * file in META-INF/services is created for each instrument
- * specific platform function. The file contains the names of classes
- * that implement the instrument specific function for each instrument type.
- * See {@link java.util.ServiceLoader} documentation for more details.
- *
- * @author anshul@marketcetera.com
- * @version $Id$
- * @since 2.0.0
- */
-package org.marketcetera.core.instruments;
\ No newline at end of file
diff --git a/trade/trade-core/src/main/java/org/marketcetera/trade/event/SimpleIncomingMessageInterceptedEvent.java b/trade/trade-core/src/main/java/org/marketcetera/trade/event/SimpleIncomingMessageInterceptedEvent.java
index 5fb49ac66f..76be0e2f3a 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/trade/event/SimpleIncomingMessageInterceptedEvent.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/trade/event/SimpleIncomingMessageInterceptedEvent.java
@@ -3,7 +3,7 @@
/* $License$ */
/**
- * Provides a POJO {@link IncomingMessageIntercetedEvent}.
+ * Provides a POJO {@link IncomingMessageInterceptedEvent}.
*
* @author Colin DuPlantis
* @version $Id$
diff --git a/trade/trade-core/src/main/java/org/marketcetera/trade/event/SimpleOutgoingMessageInterceptedEvent.java b/trade/trade-core/src/main/java/org/marketcetera/trade/event/SimpleOutgoingMessageInterceptedEvent.java
index 939f6716a3..1e2dc55c9c 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/trade/event/SimpleOutgoingMessageInterceptedEvent.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/trade/event/SimpleOutgoingMessageInterceptedEvent.java
@@ -3,7 +3,7 @@
/* $License$ */
/**
- * Provides a POJO {@link OutgoingMessageIntercetedEvent}.
+ * Provides a POJO {@link OutgoingMessageInterceptedEvent}.
*
* @author Colin DuPlantis
* @version $Id$
diff --git a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleCurrentPositionFactory.java b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleCurrentPositionFactory.java
index 36ce6e688e..f8cba4c727 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleCurrentPositionFactory.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleCurrentPositionFactory.java
@@ -3,6 +3,8 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,28 +14,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class SimpleCurrentPositionFactory
- implements org.marketcetera.trade.pnl.CurrentPositionFactory
+ implements CurrentPositionFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.SimpleCurrentPosition instance.
+ * Create a new SimpleCurrentPosition instance.
*
- * @return a org.marketcetera.trade.pnl.SimpleCurrentPosition value
+ * @return a SimpleCurrentPosition value
*/
@Override
- public org.marketcetera.trade.pnl.SimpleCurrentPosition create()
+ public SimpleCurrentPosition create()
{
- return new org.marketcetera.trade.pnl.SimpleCurrentPosition();
+ return new SimpleCurrentPosition();
}
/**
- * Create a new org.marketcetera.trade.pnl.SimpleCurrentPosition instance from the given object.
+ * Create a new SimpleCurrentPosition instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.SimpleCurrentPosition value
- * @return a org.marketcetera.trade.pnl.SimpleCurrentPosition value
+ * @param inSimpleCurrentPosition a SimpleCurrentPosition value
+ * @return a SimpleCurrentPosition value
*/
@Override
- public org.marketcetera.trade.pnl.SimpleCurrentPosition create(org.marketcetera.trade.pnl.CurrentPosition inSimpleCurrentPosition)
+ public SimpleCurrentPosition create(CurrentPosition inSimpleCurrentPosition)
{
- return new org.marketcetera.trade.pnl.SimpleCurrentPosition(inSimpleCurrentPosition);
+ return new SimpleCurrentPosition(inSimpleCurrentPosition);
}
}
diff --git a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleLotFactory.java b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleLotFactory.java
index 53b26ba129..3148e2e6f8 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleLotFactory.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleLotFactory.java
@@ -3,6 +3,8 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,28 +14,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class SimpleLotFactory
- implements org.marketcetera.trade.pnl.LotFactory
+ implements LotFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.SimpleLot instance.
+ * Create a new SimpleLot instance.
*
- * @return a org.marketcetera.trade.pnl.SimpleLot value
+ * @return a SimpleLot value
*/
@Override
- public org.marketcetera.trade.pnl.SimpleLot create()
+ public SimpleLot create()
{
- return new org.marketcetera.trade.pnl.SimpleLot();
+ return new SimpleLot();
}
/**
- * Create a new org.marketcetera.trade.pnl.SimpleLot instance from the given object.
+ * Create a new SimpleLot instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.SimpleLot value
- * @return a org.marketcetera.trade.pnl.SimpleLot value
+ * @param inLot a SimpleLot value
+ * @return a SimpleLot value
*/
@Override
- public org.marketcetera.trade.pnl.SimpleLot create(org.marketcetera.trade.pnl.Lot inSimpleLot)
+ public SimpleLot create(Lot inLot)
{
- return new org.marketcetera.trade.pnl.SimpleLot(inSimpleLot);
+ return new SimpleLot(inLot);
}
}
diff --git a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimplePositionFactory.java b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimplePositionFactory.java
index 3b7e8512ef..ad2862dda7 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimplePositionFactory.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimplePositionFactory.java
@@ -3,6 +3,8 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,28 +14,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class SimplePositionFactory
- implements org.marketcetera.trade.pnl.PositionFactory
+ implements PositionFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.SimplePosition instance.
+ * Create a new SimplePosition instance.
*
- * @return a org.marketcetera.trade.pnl.SimplePosition value
+ * @return a SimplePosition value
*/
@Override
- public org.marketcetera.trade.pnl.SimplePosition create()
+ public SimplePosition create()
{
- return new org.marketcetera.trade.pnl.SimplePosition();
+ return new SimplePosition();
}
/**
- * Create a new org.marketcetera.trade.pnl.SimplePosition instance from the given object.
+ * Create a new SimplePosition instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.SimplePosition value
- * @return a org.marketcetera.trade.pnl.SimplePosition value
+ * @param inPosition a SimplePosition value
+ * @return a SimplePosition value
*/
@Override
- public org.marketcetera.trade.pnl.SimplePosition create(org.marketcetera.trade.pnl.Position inSimplePosition)
+ public SimplePosition create(Position inPosition)
{
- return new org.marketcetera.trade.pnl.SimplePosition(inSimplePosition);
+ return new SimplePosition(inPosition);
}
}
diff --git a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleProfitAndLossFactory.java b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleProfitAndLossFactory.java
index 90bf8f77fc..ec45c7e03d 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleProfitAndLossFactory.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleProfitAndLossFactory.java
@@ -3,6 +3,8 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,28 +14,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class SimpleProfitAndLossFactory
- implements org.marketcetera.trade.pnl.ProfitAndLossFactory
+ implements ProfitAndLossFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.SimpleProfitAndLoss instance.
+ * Create a new SimpleProfitAndLoss instance.
*
- * @return a org.marketcetera.trade.pnl.SimpleProfitAndLoss value
+ * @return a SimpleProfitAndLoss value
*/
@Override
- public org.marketcetera.trade.pnl.SimpleProfitAndLoss create()
+ public SimpleProfitAndLoss create()
{
- return new org.marketcetera.trade.pnl.SimpleProfitAndLoss();
+ return new SimpleProfitAndLoss();
}
/**
- * Create a new org.marketcetera.trade.pnl.SimpleProfitAndLoss instance from the given object.
+ * Create a new SimpleProfitAndLoss instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.SimpleProfitAndLoss value
- * @return a org.marketcetera.trade.pnl.SimpleProfitAndLoss value
+ * @param inProfitAndLoss a ProfitAndLoss value
+ * @return a SimpleProfitAndLoss value
*/
@Override
- public org.marketcetera.trade.pnl.SimpleProfitAndLoss create(org.marketcetera.trade.pnl.ProfitAndLoss inSimpleProfitAndLoss)
+ public SimpleProfitAndLoss create(ProfitAndLoss inProfitAndLoss)
{
- return new org.marketcetera.trade.pnl.SimpleProfitAndLoss(inSimpleProfitAndLoss);
+ return new SimpleProfitAndLoss(inProfitAndLoss);
}
}
diff --git a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleTradeFactory.java b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleTradeFactory.java
index 2834675aa5..88575177fc 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleTradeFactory.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleTradeFactory.java
@@ -3,6 +3,8 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,28 +14,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class SimpleTradeFactory
- implements org.marketcetera.trade.pnl.TradeFactory
+ implements TradeFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.SimpleTrade instance.
+ * Create a new SimpleTrade instance.
*
- * @return a org.marketcetera.trade.pnl.SimpleTrade value
+ * @return a SimpleTrade value
*/
@Override
- public org.marketcetera.trade.pnl.SimpleTrade create()
+ public SimpleTrade create()
{
- return new org.marketcetera.trade.pnl.SimpleTrade();
+ return new SimpleTrade();
}
/**
- * Create a new org.marketcetera.trade.pnl.SimpleTrade instance from the given object.
+ * Create a new SimpleTrade instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.SimpleTrade value
- * @return a org.marketcetera.trade.pnl.SimpleTrade value
+ * @param inTrade a Trade value
+ * @return a SimpleTrade value
*/
@Override
- public org.marketcetera.trade.pnl.SimpleTrade create(org.marketcetera.trade.pnl.Trade inSimpleTrade)
+ public SimpleTrade create(Trade inTrade)
{
- return new org.marketcetera.trade.pnl.SimpleTrade(inSimpleTrade);
+ return new SimpleTrade(inTrade);
}
}
diff --git a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleUserTradeFactory.java b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleUserTradeFactory.java
index c4867a7912..4fbe9bc95a 100644
--- a/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleUserTradeFactory.java
+++ b/trade/trade-core/src/main/java/org/marketcetera/trade/pnl/SimpleUserTradeFactory.java
@@ -3,6 +3,8 @@
//
package org.marketcetera.trade.pnl;
+import org.marketcetera.core.Preserve;
+
/* $License$ */
/**
@@ -12,28 +14,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class SimpleUserTradeFactory
- implements org.marketcetera.trade.pnl.UserTradeFactory
+ implements UserTradeFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.SimpleUserTrade instance.
+ * Create a new SimpleUserTrade instance.
*
- * @return a org.marketcetera.trade.pnl.SimpleUserTrade value
+ * @return a SimpleUserTrade value
*/
@Override
- public org.marketcetera.trade.pnl.SimpleUserTrade create()
+ public SimpleUserTrade create()
{
- return new org.marketcetera.trade.pnl.SimpleUserTrade();
+ return new SimpleUserTrade();
}
/**
- * Create a new org.marketcetera.trade.pnl.SimpleUserTrade instance from the given object.
+ * Create a new SimpleUserTrade instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.SimpleUserTrade value
- * @return a org.marketcetera.trade.pnl.SimpleUserTrade value
+ * @param inUserTrade a UserTrade value
+ * @return a SimpleUserTrade value
*/
@Override
- public org.marketcetera.trade.pnl.SimpleUserTrade create(org.marketcetera.trade.pnl.UserTrade inSimpleUserTrade)
+ public SimpleUserTrade create(UserTrade inUserTrade)
{
- return new org.marketcetera.trade.pnl.SimpleUserTrade(inSimpleUserTrade);
+ return new SimpleUserTrade(inUserTrade);
}
}
diff --git a/trade/trade-rpc-core/src/main/java/org/marketcetera/trade/pnl/TradePnlRpcUtil.java b/trade/trade-rpc-core/src/main/java/org/marketcetera/trade/pnl/TradePnlRpcUtil.java
index a37ae0e2f6..c2739eb004 100644
--- a/trade/trade-rpc-core/src/main/java/org/marketcetera/trade/pnl/TradePnlRpcUtil.java
+++ b/trade/trade-rpc-core/src/main/java/org/marketcetera/trade/pnl/TradePnlRpcUtil.java
@@ -3,6 +3,14 @@
//
package org.marketcetera.trade.pnl;
+import java.util.Optional;
+
+import org.marketcetera.admin.UserFactory;
+import org.marketcetera.admin.rpc.AdminRpcUtil;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.rpc.base.BaseRpcUtil;
+import org.marketcetera.trading.rpc.TradeRpcUtil;
+
/* $License$ */
/**
@@ -12,266 +20,283 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public abstract class TradePnlRpcUtil
{
/**
* Get the RPC object from the given value.
*
- * @param inPosition a org.marketcetera.trade.pnl.Position value
- * @return a java.util.Optional value
+ * @param inPosition a Position value
+ * @return a Optional<TradePnlTypesRpc.PnlPosition> value
*/
- public static java.util.Optional getRpcPnlPosition(org.marketcetera.trade.pnl.Position inPosition)
+ public static Optional getRpcPnlPosition(Position inPosition)
{
if(inPosition == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
TradePnlTypesRpc.PnlPosition.Builder builder = TradePnlTypesRpc.PnlPosition.newBuilder();
- org.marketcetera.trading.rpc.TradeRpcUtil.getRpcInstrument(inPosition.getInstrument()).ifPresent(value->builder.setInstrument(value));
- org.marketcetera.admin.rpc.AdminRpcUtil.getRpcUser(inPosition.getUser()).ifPresent(value->builder.setUser(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inPosition.getPosition()).ifPresent(value->builder.setPosition(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getTimestampValue(inPosition.getEffectiveDate()).ifPresent(value->builder.setEffectiveDate(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inPosition.getWeightedAverageCost()).ifPresent(value->builder.setWeightedAverageCost(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inPosition.getRealizedGain()).ifPresent(value->builder.setRealizedGain(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inPosition.getUnrealizedGain()).ifPresent(value->builder.setUnrealizedGain(value));
- return java.util.Optional.of(builder.build());
+ TradeRpcUtil.getRpcInstrument(inPosition.getInstrument()).ifPresent(value->builder.setInstrument(value));
+ AdminRpcUtil.getRpcUser(inPosition.getUser()).ifPresent(value->builder.setUser(value));
+ BaseRpcUtil.getRpcQty(inPosition.getPosition()).ifPresent(value->builder.setPosition(value));
+ BaseRpcUtil.getTimestampValue(inPosition.getEffectiveDate()).ifPresent(value->builder.setEffectiveDate(value));
+ BaseRpcUtil.getRpcQty(inPosition.getWeightedAverageCost()).ifPresent(value->builder.setWeightedAverageCost(value));
+ BaseRpcUtil.getRpcQty(inPosition.getRealizedGain()).ifPresent(value->builder.setRealizedGain(value));
+ BaseRpcUtil.getRpcQty(inPosition.getUnrealizedGain()).ifPresent(value->builder.setUnrealizedGain(value));
+ return Optional.of(builder.build());
}
/**
* Get the RPC object from the given value.
*
- * @param inCurrentPosition a org.marketcetera.trade.pnl.CurrentPosition value
- * @return a java.util.Optional value
+ * @param inCurrentPosition a CurrentPosition value
+ * @return an Optional<TradePnlTypesRpc.CurrentPnlPosition< value
*/
- public static java.util.Optional getRpcCurrentPnlPosition(org.marketcetera.trade.pnl.CurrentPosition inCurrentPosition)
+ public static Optional getRpcCurrentPnlPosition(CurrentPosition inCurrentPosition)
{
if(inCurrentPosition == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
TradePnlTypesRpc.CurrentPnlPosition.Builder builder = TradePnlTypesRpc.CurrentPnlPosition.newBuilder();
- org.marketcetera.trading.rpc.TradeRpcUtil.getRpcInstrument(inCurrentPosition.getInstrument()).ifPresent(value->builder.setInstrument(value));
- org.marketcetera.admin.rpc.AdminRpcUtil.getRpcUser(inCurrentPosition.getUser()).ifPresent(value->builder.setUser(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inCurrentPosition.getPosition()).ifPresent(value->builder.setPosition(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inCurrentPosition.getWeightedAverageCost()).ifPresent(value->builder.setWeightedAverageCost(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inCurrentPosition.getRealizedGain()).ifPresent(value->builder.setRealizedGain(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inCurrentPosition.getUnrealizedGain()).ifPresent(value->builder.setUnrealizedGain(value));
- return java.util.Optional.of(builder.build());
+ TradeRpcUtil.getRpcInstrument(inCurrentPosition.getInstrument()).ifPresent(value->builder.setInstrument(value));
+ AdminRpcUtil.getRpcUser(inCurrentPosition.getUser()).ifPresent(value->builder.setUser(value));
+ BaseRpcUtil.getRpcQty(inCurrentPosition.getPosition()).ifPresent(value->builder.setPosition(value));
+ BaseRpcUtil.getRpcQty(inCurrentPosition.getWeightedAverageCost()).ifPresent(value->builder.setWeightedAverageCost(value));
+ BaseRpcUtil.getRpcQty(inCurrentPosition.getRealizedGain()).ifPresent(value->builder.setRealizedGain(value));
+ BaseRpcUtil.getRpcQty(inCurrentPosition.getUnrealizedGain()).ifPresent(value->builder.setUnrealizedGain(value));
+ return Optional.of(builder.build());
}
/**
* Get the RPC object from the given value.
*
- * @param inProfitAndLoss a org.marketcetera.trade.pnl.ProfitAndLoss value
- * @return a java.util.Optional value
+ * @param inProfitAndLoss a ProfitAndLoss value
+ * @return an Optional<TradePnlTypesRpc.ProfitAndLoss> value
*/
- public static java.util.Optional getRpcProfitAndLoss(org.marketcetera.trade.pnl.ProfitAndLoss inProfitAndLoss)
+ public static Optional getRpcProfitAndLoss(ProfitAndLoss inProfitAndLoss)
{
if(inProfitAndLoss == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
TradePnlTypesRpc.ProfitAndLoss.Builder builder = TradePnlTypesRpc.ProfitAndLoss.newBuilder();
- org.marketcetera.trading.rpc.TradeRpcUtil.getRpcInstrument(inProfitAndLoss.getInstrument()).ifPresent(value->builder.setInstrument(value));
- org.marketcetera.admin.rpc.AdminRpcUtil.getRpcUser(inProfitAndLoss.getUser()).ifPresent(value->builder.setUser(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inProfitAndLoss.getRealizedGain()).ifPresent(value->builder.setRealizedGain(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inProfitAndLoss.getUnrealizedGain()).ifPresent(value->builder.setUnrealizedGain(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inProfitAndLoss.getBasisPrice()).ifPresent(value->builder.setBasisPrice(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inProfitAndLoss.getPosition()).ifPresent(value->builder.setPosition(value));
- return java.util.Optional.of(builder.build());
+ TradeRpcUtil.getRpcInstrument(inProfitAndLoss.getInstrument()).ifPresent(value->builder.setInstrument(value));
+ AdminRpcUtil.getRpcUser(inProfitAndLoss.getUser()).ifPresent(value->builder.setUser(value));
+ BaseRpcUtil.getRpcQty(inProfitAndLoss.getRealizedGain()).ifPresent(value->builder.setRealizedGain(value));
+ BaseRpcUtil.getRpcQty(inProfitAndLoss.getUnrealizedGain()).ifPresent(value->builder.setUnrealizedGain(value));
+ BaseRpcUtil.getRpcQty(inProfitAndLoss.getBasisPrice()).ifPresent(value->builder.setBasisPrice(value));
+ BaseRpcUtil.getRpcQty(inProfitAndLoss.getPosition()).ifPresent(value->builder.setPosition(value));
+ return Optional.of(builder.build());
}
/**
* Get the RPC object from the given value.
*
- * @param inLot a org.marketcetera.trade.pnl.Lot value
- * @return a java.util.Optional value
+ * @param inLot a Lot value
+ * @return an Optional<TradePnlTypesRpc.Lot> value
*/
- public static java.util.Optional getRpcLot(org.marketcetera.trade.pnl.Lot inLot)
+ public static Optional getRpcLot(Lot inLot)
{
if(inLot == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
TradePnlTypesRpc.Lot.Builder builder = TradePnlTypesRpc.Lot.newBuilder();
- org.marketcetera.admin.rpc.AdminRpcUtil.getRpcUser(inLot.getUser()).ifPresent(value->builder.setUser(value));
- org.marketcetera.trade.pnl.TradePnlRpcUtil.getRpcTrade(inLot.getTrade()).ifPresent(value->builder.setTrade(value));
- org.marketcetera.trade.pnl.TradePnlRpcUtil.getRpcPnlPosition(inLot.getPosition()).ifPresent(value->builder.setPosition(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inLot.getQuantity()).ifPresent(value->builder.setQuantity(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inLot.getAllocatedQuantity()).ifPresent(value->builder.setAllocatedQuantity(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getTimestampValue(inLot.getEffectiveDate()).ifPresent(value->builder.setEffectiveDate(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inLot.getBasisPrice()).ifPresent(value->builder.setBasisPrice(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inLot.getGain()).ifPresent(value->builder.setGain(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inLot.getTradePrice()).ifPresent(value->builder.setTradePrice(value));
- return java.util.Optional.of(builder.build());
+ AdminRpcUtil.getRpcUser(inLot.getUser()).ifPresent(value->builder.setUser(value));
+ TradePnlRpcUtil.getRpcTrade(inLot.getTrade()).ifPresent(value->builder.setTrade(value));
+ TradePnlRpcUtil.getRpcPnlPosition(inLot.getPosition()).ifPresent(value->builder.setPosition(value));
+ BaseRpcUtil.getRpcQty(inLot.getQuantity()).ifPresent(value->builder.setQuantity(value));
+ BaseRpcUtil.getRpcQty(inLot.getAllocatedQuantity()).ifPresent(value->builder.setAllocatedQuantity(value));
+ BaseRpcUtil.getTimestampValue(inLot.getEffectiveDate()).ifPresent(value->builder.setEffectiveDate(value));
+ BaseRpcUtil.getRpcQty(inLot.getBasisPrice()).ifPresent(value->builder.setBasisPrice(value));
+ BaseRpcUtil.getRpcQty(inLot.getGain()).ifPresent(value->builder.setGain(value));
+ BaseRpcUtil.getRpcQty(inLot.getTradePrice()).ifPresent(value->builder.setTradePrice(value));
+ return Optional.of(builder.build());
}
/**
* Get the RPC object from the given value.
*
- * @param inTrade a org.marketcetera.trade.pnl.Trade value
- * @return a java.util.Optional value
+ * @param inTrade a Trade value
+ * @return an Optional<TradePnlTypesRpc.Trade> value
*/
- public static java.util.Optional getRpcTrade(org.marketcetera.trade.pnl.Trade inTrade)
+ public static Optional getRpcTrade(Trade inTrade)
{
if(inTrade == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
TradePnlTypesRpc.Trade.Builder builder = TradePnlTypesRpc.Trade.newBuilder();
- org.marketcetera.trading.rpc.TradeRpcUtil.getRpcInstrument(inTrade.getInstrument()).ifPresent(value->builder.setInstrument(value));
- org.marketcetera.trading.rpc.TradeRpcUtil.getRpcOrderId(inTrade.getExecutionId()).ifPresent(value->builder.setExecutionId(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inTrade.getPrice()).ifPresent(value->builder.setPrice(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getRpcQty(inTrade.getQuantity()).ifPresent(value->builder.setQuantity(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getTimestampValue(inTrade.getTransactionTime()).ifPresent(value->builder.setTransactionTime(value));
- return java.util.Optional.of(builder.build());
+ TradeRpcUtil.getRpcInstrument(inTrade.getInstrument()).ifPresent(value->builder.setInstrument(value));
+ TradeRpcUtil.getRpcOrderId(inTrade.getExecutionId()).ifPresent(value->builder.setExecutionId(value));
+ BaseRpcUtil.getRpcQty(inTrade.getPrice()).ifPresent(value->builder.setPrice(value));
+ BaseRpcUtil.getRpcQty(inTrade.getQuantity()).ifPresent(value->builder.setQuantity(value));
+ BaseRpcUtil.getTimestampValue(inTrade.getTransactionTime()).ifPresent(value->builder.setTransactionTime(value));
+ return Optional.of(builder.build());
}
/**
* Get the RPC object from the given value.
*
- * @param inUserTrade a org.marketcetera.trade.pnl.UserTrade value
- * @return a java.util.Optional value
+ * @param inUserTrade a UserTrade value
+ * @return an Optional<TradePnlTypesRpc.UserTrade> value
*/
- public static java.util.Optional getRpcUserTrade(org.marketcetera.trade.pnl.UserTrade inUserTrade)
+ public static Optional getRpcUserTrade(UserTrade inUserTrade)
{
if(inUserTrade == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
TradePnlTypesRpc.UserTrade.Builder builder = TradePnlTypesRpc.UserTrade.newBuilder();
- org.marketcetera.trade.pnl.TradePnlRpcUtil.getRpcTrade(inUserTrade.getTrade()).ifPresent(value->builder.setTrade(value));
- org.marketcetera.admin.rpc.AdminRpcUtil.getRpcUser(inUserTrade.getUser()).ifPresent(value->builder.setUser(value));
- builder.setSide(org.marketcetera.trading.rpc.TradeRpcUtil.getRpcSide(inUserTrade.getSide()));
- org.marketcetera.trade.pnl.TradePnlRpcUtil.getRpcProfitAndLoss(inUserTrade.getProfitAndLoss()).ifPresent(value->builder.setProfitAndLoss(value));
- org.marketcetera.trading.rpc.TradeRpcUtil.getRpcOrderId(inUserTrade.getOrderId()).ifPresent(value->builder.setOrderId(value));
- return java.util.Optional.of(builder.build());
+ TradePnlRpcUtil.getRpcTrade(inUserTrade.getTrade()).ifPresent(value->builder.setTrade(value));
+ AdminRpcUtil.getRpcUser(inUserTrade.getUser()).ifPresent(value->builder.setUser(value));
+ builder.setSide(TradeRpcUtil.getRpcSide(inUserTrade.getSide()));
+ TradePnlRpcUtil.getRpcProfitAndLoss(inUserTrade.getProfitAndLoss()).ifPresent(value->builder.setProfitAndLoss(value));
+ TradeRpcUtil.getRpcOrderId(inUserTrade.getOrderId()).ifPresent(value->builder.setOrderId(value));
+ return Optional.of(builder.build());
}
/**
* Get the object from the given RPC value.
*
- * @param inPosition a org.marketcetera.trade.pnl.TradePnlTypesRpc.PnlPosition value
- * @param inPositionFactory a org.marketcetera.trade.pnl.PositionFactory value
- * @param inUserFactory a org.marketcetera.admin.UserFactory value
- * @return a org.marketcetera.trade.pnl.Position value
+ * @param inPosition a TradePnlTypesRpc.PnlPosition value
+ * @param inPositionFactory a PositionFactory value
+ * @param inUserFactory a UserFactory value
+ * @return an Optional<Position< value
*/
- public static java.util.Optional getPnlPosition(org.marketcetera.trade.pnl.TradePnlTypesRpc.PnlPosition inPosition,org.marketcetera.trade.pnl.PositionFactory inPositionFactory,org.marketcetera.admin.UserFactory inUserFactory)
+ public static Optional getPnlPosition(TradePnlTypesRpc.PnlPosition inPosition,
+ PositionFactory inPositionFactory,
+ UserFactory inUserFactory)
{
if(inPosition == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
- org.marketcetera.trade.pnl.Position position = inPositionFactory.create();
- org.marketcetera.trading.rpc.TradeRpcUtil.getInstrument(inPosition.getInstrument()).ifPresent(value->position.setInstrument(value));
- org.marketcetera.admin.rpc.AdminRpcUtil.getUser(inPosition.getUser(),inUserFactory).ifPresent(value->position.setUser(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inPosition.getPosition()).ifPresent(value->position.setPosition(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getDateValue(inPosition.getEffectiveDate()).ifPresent(value->position.setEffectiveDate(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inPosition.getWeightedAverageCost()).ifPresent(value->position.setWeightedAverageCost(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inPosition.getRealizedGain()).ifPresent(value->position.setRealizedGain(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inPosition.getUnrealizedGain()).ifPresent(value->position.setUnrealizedGain(value));
- return java.util.Optional.of(position);
+ Position position = inPositionFactory.create();
+ TradeRpcUtil.getInstrument(inPosition.getInstrument()).ifPresent(value->position.setInstrument(value));
+ AdminRpcUtil.getUser(inPosition.getUser(),inUserFactory).ifPresent(value->position.setUser(value));
+ BaseRpcUtil.getScaledQuantity(inPosition.getPosition()).ifPresent(value->position.setPosition(value));
+ BaseRpcUtil.getDateValue(inPosition.getEffectiveDate()).ifPresent(value->position.setEffectiveDate(value));
+ BaseRpcUtil.getScaledQuantity(inPosition.getWeightedAverageCost()).ifPresent(value->position.setWeightedAverageCost(value));
+ BaseRpcUtil.getScaledQuantity(inPosition.getRealizedGain()).ifPresent(value->position.setRealizedGain(value));
+ BaseRpcUtil.getScaledQuantity(inPosition.getUnrealizedGain()).ifPresent(value->position.setUnrealizedGain(value));
+ return Optional.of(position);
}
/**
* Get the object from the given RPC value.
*
- * @param inCurrentPosition a org.marketcetera.trade.pnl.TradePnlTypesRpc.CurrentPnlPosition value
- * @param inCurrentPositionFactory a org.marketcetera.trade.pnl.CurrentPositionFactory value
- * @param inUserFactory a org.marketcetera.admin.UserFactory value
- * @return a org.marketcetera.trade.pnl.CurrentPosition value
+ * @param inCurrentPosition a TradePnlTypesRpc.CurrentPnlPosition value
+ * @param inCurrentPositionFactory a CurrentPositionFactory value
+ * @param inUserFactory a UserFactory value
+ * @return an Optional<CurrentPosition> value
*/
- public static java.util.Optional getCurrentPnlPosition(org.marketcetera.trade.pnl.TradePnlTypesRpc.CurrentPnlPosition inCurrentPosition,org.marketcetera.trade.pnl.CurrentPositionFactory inCurrentPositionFactory,org.marketcetera.admin.UserFactory inUserFactory)
+ public static Optional getCurrentPnlPosition(TradePnlTypesRpc.CurrentPnlPosition inCurrentPosition,
+ CurrentPositionFactory inCurrentPositionFactory,
+ UserFactory inUserFactory)
{
if(inCurrentPosition == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
- org.marketcetera.trade.pnl.CurrentPosition currentPosition = inCurrentPositionFactory.create();
- org.marketcetera.trading.rpc.TradeRpcUtil.getInstrument(inCurrentPosition.getInstrument()).ifPresent(value->currentPosition.setInstrument(value));
- org.marketcetera.admin.rpc.AdminRpcUtil.getUser(inCurrentPosition.getUser(),inUserFactory).ifPresent(value->currentPosition.setUser(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inCurrentPosition.getPosition()).ifPresent(value->currentPosition.setPosition(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inCurrentPosition.getWeightedAverageCost()).ifPresent(value->currentPosition.setWeightedAverageCost(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inCurrentPosition.getRealizedGain()).ifPresent(value->currentPosition.setRealizedGain(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inCurrentPosition.getUnrealizedGain()).ifPresent(value->currentPosition.setUnrealizedGain(value));
- return java.util.Optional.of(currentPosition);
+ CurrentPosition currentPosition = inCurrentPositionFactory.create();
+ TradeRpcUtil.getInstrument(inCurrentPosition.getInstrument()).ifPresent(value->currentPosition.setInstrument(value));
+ AdminRpcUtil.getUser(inCurrentPosition.getUser(),inUserFactory).ifPresent(value->currentPosition.setUser(value));
+ BaseRpcUtil.getScaledQuantity(inCurrentPosition.getPosition()).ifPresent(value->currentPosition.setPosition(value));
+ BaseRpcUtil.getScaledQuantity(inCurrentPosition.getWeightedAverageCost()).ifPresent(value->currentPosition.setWeightedAverageCost(value));
+ BaseRpcUtil.getScaledQuantity(inCurrentPosition.getRealizedGain()).ifPresent(value->currentPosition.setRealizedGain(value));
+ BaseRpcUtil.getScaledQuantity(inCurrentPosition.getUnrealizedGain()).ifPresent(value->currentPosition.setUnrealizedGain(value));
+ return Optional.of(currentPosition);
}
/**
* Get the object from the given RPC value.
*
- * @param inProfitAndLoss a org.marketcetera.trade.pnl.TradePnlTypesRpc.ProfitAndLoss value
- * @param inProfitAndLossFactory a org.marketcetera.trade.pnl.ProfitAndLossFactory value
- * @param inUserFactory a org.marketcetera.admin.UserFactory value
- * @return a org.marketcetera.trade.pnl.ProfitAndLoss value
+ * @param inProfitAndLoss a TradePnlTypesRpc.ProfitAndLoss value
+ * @param inProfitAndLossFactory a ProfitAndLossFactory value
+ * @param inUserFactory a UserFactory value
+ * @return an Optional<ProfitAndLoss> value
*/
- public static java.util.Optional getProfitAndLoss(org.marketcetera.trade.pnl.TradePnlTypesRpc.ProfitAndLoss inProfitAndLoss,org.marketcetera.trade.pnl.ProfitAndLossFactory inProfitAndLossFactory,org.marketcetera.admin.UserFactory inUserFactory)
+ public static Optional getProfitAndLoss(TradePnlTypesRpc.ProfitAndLoss inProfitAndLoss,
+ ProfitAndLossFactory inProfitAndLossFactory,
+ UserFactory inUserFactory)
{
if(inProfitAndLoss == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
- org.marketcetera.trade.pnl.ProfitAndLoss profitAndLoss = inProfitAndLossFactory.create();
- org.marketcetera.trading.rpc.TradeRpcUtil.getInstrument(inProfitAndLoss.getInstrument()).ifPresent(value->profitAndLoss.setInstrument(value));
- org.marketcetera.admin.rpc.AdminRpcUtil.getUser(inProfitAndLoss.getUser(),inUserFactory).ifPresent(value->profitAndLoss.setUser(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inProfitAndLoss.getRealizedGain()).ifPresent(value->profitAndLoss.setRealizedGain(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inProfitAndLoss.getUnrealizedGain()).ifPresent(value->profitAndLoss.setUnrealizedGain(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inProfitAndLoss.getBasisPrice()).ifPresent(value->profitAndLoss.setBasisPrice(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inProfitAndLoss.getPosition()).ifPresent(value->profitAndLoss.setPosition(value));
- return java.util.Optional.of(profitAndLoss);
+ ProfitAndLoss profitAndLoss = inProfitAndLossFactory.create();
+ TradeRpcUtil.getInstrument(inProfitAndLoss.getInstrument()).ifPresent(value->profitAndLoss.setInstrument(value));
+ AdminRpcUtil.getUser(inProfitAndLoss.getUser(),inUserFactory).ifPresent(value->profitAndLoss.setUser(value));
+ BaseRpcUtil.getScaledQuantity(inProfitAndLoss.getRealizedGain()).ifPresent(value->profitAndLoss.setRealizedGain(value));
+ BaseRpcUtil.getScaledQuantity(inProfitAndLoss.getUnrealizedGain()).ifPresent(value->profitAndLoss.setUnrealizedGain(value));
+ BaseRpcUtil.getScaledQuantity(inProfitAndLoss.getBasisPrice()).ifPresent(value->profitAndLoss.setBasisPrice(value));
+ BaseRpcUtil.getScaledQuantity(inProfitAndLoss.getPosition()).ifPresent(value->profitAndLoss.setPosition(value));
+ return Optional.of(profitAndLoss);
}
/**
* Get the object from the given RPC value.
*
- * @param inLot a org.marketcetera.trade.pnl.TradePnlTypesRpc.Lot value
- * @param inLotFactory a org.marketcetera.trade.pnl.LotFactory value
- * @param inProfitAndLossFactory a org.marketcetera.trade.pnl.ProfitAndLossFactory value
- * @param inTradeFactory a org.marketcetera.trade.pnl.TradeFactory value
- * @param inUserFactory a org.marketcetera.admin.UserFactory value
- * @param inPositionFactory a org.marketcetera.trade.pnl.PositionFactory value
- * @return a org.marketcetera.trade.pnl.Lot value
+ * @param inLot a TradePnlTypesRpc.Lot value
+ * @param inLotFactory a LotFactory value
+ * @param inProfitAndLossFactory a ProfitAndLossFactory value
+ * @param inTradeFactory a TradeFactory value
+ * @param inUserFactory a UserFactory value
+ * @param inPositionFactory a PositionFactory value
+ * @return an Optional<Lot> value
*/
- public static java.util.Optional getLot(org.marketcetera.trade.pnl.TradePnlTypesRpc.Lot inLot,org.marketcetera.trade.pnl.LotFactory inLotFactory,org.marketcetera.trade.pnl.ProfitAndLossFactory inProfitAndLossFactory,org.marketcetera.trade.pnl.TradeFactory inTradeFactory,org.marketcetera.admin.UserFactory inUserFactory,org.marketcetera.trade.pnl.PositionFactory inPositionFactory)
+ public static Optional getLot(TradePnlTypesRpc.Lot inLot,
+ LotFactory inLotFactory,
+ ProfitAndLossFactory inProfitAndLossFactory,
+ TradeFactory inTradeFactory,
+ UserFactory inUserFactory,
+ PositionFactory inPositionFactory)
{
if(inLot == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
- org.marketcetera.trade.pnl.Lot lot = inLotFactory.create();
- org.marketcetera.admin.rpc.AdminRpcUtil.getUser(inLot.getUser(),inUserFactory).ifPresent(value->lot.setUser(value));
- org.marketcetera.trade.pnl.TradePnlRpcUtil.getTrade(inLot.getTrade(),inTradeFactory).ifPresent(value->lot.setTrade(value));
- org.marketcetera.trade.pnl.TradePnlRpcUtil.getPnlPosition(inLot.getPosition(),inPositionFactory,inUserFactory).ifPresent(value->lot.setPosition(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inLot.getQuantity()).ifPresent(value->lot.setQuantity(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inLot.getAllocatedQuantity()).ifPresent(value->lot.setAllocatedQuantity(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getDateValue(inLot.getEffectiveDate()).ifPresent(value->lot.setEffectiveDate(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inLot.getBasisPrice()).ifPresent(value->lot.setBasisPrice(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inLot.getGain()).ifPresent(value->lot.setGain(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inLot.getTradePrice()).ifPresent(value->lot.setTradePrice(value));
- return java.util.Optional.of(lot);
+ Lot lot = inLotFactory.create();
+ AdminRpcUtil.getUser(inLot.getUser(),inUserFactory).ifPresent(value->lot.setUser(value));
+ TradePnlRpcUtil.getTrade(inLot.getTrade(),inTradeFactory).ifPresent(value->lot.setTrade(value));
+ TradePnlRpcUtil.getPnlPosition(inLot.getPosition(),inPositionFactory,inUserFactory).ifPresent(value->lot.setPosition(value));
+ BaseRpcUtil.getScaledQuantity(inLot.getQuantity()).ifPresent(value->lot.setQuantity(value));
+ BaseRpcUtil.getScaledQuantity(inLot.getAllocatedQuantity()).ifPresent(value->lot.setAllocatedQuantity(value));
+ BaseRpcUtil.getDateValue(inLot.getEffectiveDate()).ifPresent(value->lot.setEffectiveDate(value));
+ BaseRpcUtil.getScaledQuantity(inLot.getBasisPrice()).ifPresent(value->lot.setBasisPrice(value));
+ BaseRpcUtil.getScaledQuantity(inLot.getGain()).ifPresent(value->lot.setGain(value));
+ BaseRpcUtil.getScaledQuantity(inLot.getTradePrice()).ifPresent(value->lot.setTradePrice(value));
+ return Optional.of(lot);
}
/**
* Get the object from the given RPC value.
*
- * @param inTrade a org.marketcetera.trade.pnl.TradePnlTypesRpc.Trade value
- * @param inTradeFactory a org.marketcetera.trade.pnl.TradeFactory value
- * @return a org.marketcetera.trade.pnl.Trade value
+ * @param inTrade a TradePnlTypesRpc.Trade value
+ * @param inTradeFactory a TradeFactory value
+ * @return an Optional<Trade> value
*/
- public static java.util.Optional getTrade(org.marketcetera.trade.pnl.TradePnlTypesRpc.Trade inTrade,org.marketcetera.trade.pnl.TradeFactory inTradeFactory)
+ public static Optional getTrade(TradePnlTypesRpc.Trade inTrade,
+ TradeFactory inTradeFactory)
{
if(inTrade == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
- org.marketcetera.trade.pnl.Trade trade = inTradeFactory.create();
- org.marketcetera.trading.rpc.TradeRpcUtil.getInstrument(inTrade.getInstrument()).ifPresent(value->trade.setInstrument(value));
- org.marketcetera.trading.rpc.TradeRpcUtil.getOrderId(inTrade.getExecutionId()).ifPresent(value->trade.setExecutionId(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inTrade.getPrice()).ifPresent(value->trade.setPrice(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getScaledQuantity(inTrade.getQuantity()).ifPresent(value->trade.setQuantity(value));
- org.marketcetera.rpc.base.BaseRpcUtil.getDateValue(inTrade.getTransactionTime()).ifPresent(value->trade.setTransactionTime(value));
- return java.util.Optional.of(trade);
+ Trade trade = inTradeFactory.create();
+ TradeRpcUtil.getInstrument(inTrade.getInstrument()).ifPresent(value->trade.setInstrument(value));
+ TradeRpcUtil.getOrderId(inTrade.getExecutionId()).ifPresent(value->trade.setExecutionId(value));
+ BaseRpcUtil.getScaledQuantity(inTrade.getPrice()).ifPresent(value->trade.setPrice(value));
+ BaseRpcUtil.getScaledQuantity(inTrade.getQuantity()).ifPresent(value->trade.setQuantity(value));
+ BaseRpcUtil.getDateValue(inTrade.getTransactionTime()).ifPresent(value->trade.setTransactionTime(value));
+ return Optional.of(trade);
}
/**
* Get the object from the given RPC value.
*
- * @param inUserTrade a org.marketcetera.trade.pnl.TradePnlTypesRpc.UserTrade value
- * @param inUserTradeFactory a org.marketcetera.trade.pnl.UserTradeFactory value
- * @param inTradeFactory a org.marketcetera.trade.pnl.TradeFactory value
- * @param inProfitAndLossFactory a org.marketcetera.trade.pnl.ProfitAndLossFactory value
- * @param inUserFactory a org.marketcetera.admin.UserFactory value
- * @return a org.marketcetera.trade.pnl.UserTrade value
+ * @param inUserTrade a TradePnlTypesRpc.UserTrade value
+ * @param inUserTradeFactory a UserTradeFactory value
+ * @param inTradeFactory a TradeFactory value
+ * @param inProfitAndLossFactory a ProfitAndLossFactory value
+ * @param inUserFactory a UserFactory value
+ * @return an Optional<UserTrade> value
*/
- public static java.util.Optional getUserTrade(org.marketcetera.trade.pnl.TradePnlTypesRpc.UserTrade inUserTrade,org.marketcetera.trade.pnl.UserTradeFactory inUserTradeFactory,org.marketcetera.trade.pnl.TradeFactory inTradeFactory,org.marketcetera.trade.pnl.ProfitAndLossFactory inProfitAndLossFactory,org.marketcetera.admin.UserFactory inUserFactory)
+ public static Optional getUserTrade(TradePnlTypesRpc.UserTrade inUserTrade,
+ UserTradeFactory inUserTradeFactory,
+ TradeFactory inTradeFactory,
+ ProfitAndLossFactory inProfitAndLossFactory,
+ UserFactory inUserFactory)
{
if(inUserTrade == null) {
- return java.util.Optional.empty();
+ return Optional.empty();
}
- org.marketcetera.trade.pnl.UserTrade userTrade = inUserTradeFactory.create();
- org.marketcetera.trade.pnl.TradePnlRpcUtil.getTrade(inUserTrade.getTrade(),inTradeFactory).ifPresent(value->userTrade.setTrade(value));
- org.marketcetera.admin.rpc.AdminRpcUtil.getUser(inUserTrade.getUser(),inUserFactory).ifPresent(value->userTrade.setUser(value));
- userTrade.setSide(org.marketcetera.trading.rpc.TradeRpcUtil.getSide(inUserTrade.getSide()));
- org.marketcetera.trade.pnl.TradePnlRpcUtil.getProfitAndLoss(inUserTrade.getProfitAndLoss(),inProfitAndLossFactory,inUserFactory).ifPresent(value->userTrade.setProfitAndLoss(value));
- org.marketcetera.trading.rpc.TradeRpcUtil.getOrderId(inUserTrade.getOrderId()).ifPresent(value->userTrade.setOrderId(value));
- return java.util.Optional.of(userTrade);
+ UserTrade userTrade = inUserTradeFactory.create();
+ TradePnlRpcUtil.getTrade(inUserTrade.getTrade(),inTradeFactory).ifPresent(value->userTrade.setTrade(value));
+ AdminRpcUtil.getUser(inUserTrade.getUser(),inUserFactory).ifPresent(value->userTrade.setUser(value));
+ userTrade.setSide(TradeRpcUtil.getSide(inUserTrade.getSide()));
+ TradePnlRpcUtil.getProfitAndLoss(inUserTrade.getProfitAndLoss(),inProfitAndLossFactory,inUserFactory).ifPresent(value->userTrade.setProfitAndLoss(value));
+ TradeRpcUtil.getOrderId(inUserTrade.getOrderId()).ifPresent(value->userTrade.setOrderId(value));
+ return Optional.of(userTrade);
}
}
diff --git a/trade/trade-rpc-core/src/main/java/org/marketcetera/trading/rpc/TradeRpcUtil.java b/trade/trade-rpc-core/src/main/java/org/marketcetera/trading/rpc/TradeRpcUtil.java
index a1a9ea8ab1..f070260322 100644
--- a/trade/trade-rpc-core/src/main/java/org/marketcetera/trading/rpc/TradeRpcUtil.java
+++ b/trade/trade-rpc-core/src/main/java/org/marketcetera/trading/rpc/TradeRpcUtil.java
@@ -1128,7 +1128,7 @@ public static void setDisplayQuantity(NewOrReplaceOrder inOrder,
* Set the order ID from the given RPC order.
*
* @param inOrder an OrderBase value
- * @param inBuilder a TradeTypesRpc.OrderBase.Builder value
+ * @param inRpcOrder a TradeTypesRpc.OrderBase.Builder value
*/
public static void setOrderId(OrderBase inOrder,
TradeTypesRpc.OrderBase inRpcOrder)
@@ -1143,7 +1143,7 @@ public static void setOrderId(OrderBase inOrder,
* Set the original order ID from the given RPC order.
*
* @param inOrder a RelatedOrder value
- * @param inBuilder a TradeTypesRpc.OrderBase.Builder value
+ * @param inRpcOrder a TradeTypesRpc.OrderBase.Builder value
*/
public static void setOriginalOrderId(RelatedOrder inOrder,
TradeTypesRpc.OrderBase inRpcOrder)
@@ -1158,7 +1158,7 @@ public static void setOriginalOrderId(RelatedOrder inOrder,
* Set the broker order ID from the given RPC order.
*
* @param inOrder a RelatedOrder value
- * @param inBuilder a TradeTypesRpc.OrderBase.Builder value
+ * @param inRpcOrder a TradeTypesRpc.OrderBase.Builder value
*/
public static void setBrokerOrderId(RelatedOrder inOrder,
TradeTypesRpc.OrderBase inRpcOrder)
@@ -1173,7 +1173,7 @@ public static void setBrokerOrderId(RelatedOrder inOrder,
* Set the broker ID from the given RPC order.
*
* @param inOrder an OrderBase value
- * @param inBuilder a TradeTypesRpc.OrderBase.Builder value
+ * @param inRpcOrder a TradeTypesRpc.OrderBase.Builder value
*/
public static void setBrokerId(OrderBase inOrder,
TradeTypesRpc.OrderBase inRpcOrder)
@@ -1188,7 +1188,7 @@ public static void setBrokerId(OrderBase inOrder,
* Set the instrument from the given RPC order.
*
* @param inOrder an OrderBase value
- * @param inBuilder a TradeTypesRpc.OrderBase.Builder value
+ * @param inRpcOrder a TradeTypesRpc.OrderBase.Builder value
*/
public static void setInstrument(OrderBase inOrder,
TradeTypesRpc.OrderBase inRpcOrder)
@@ -1201,7 +1201,7 @@ public static void setInstrument(OrderBase inOrder,
* Set the account from the given RPC order.
*
* @param inOrder an OrderBase value
- * @param inBuilder a TradeTypesRpc.OrderBase.Builder value
+ * @param inRpcOrder a TradeTypesRpc.OrderBase.Builder value
*/
public static void setAccount(OrderBase inOrder,
TradeTypesRpc.OrderBase inRpcOrder)
@@ -1215,7 +1215,7 @@ public static void setAccount(OrderBase inOrder,
* Set the text from the given RPC order.
*
* @param inOrder an OrderBase value
- * @param inBuilder a TradeTypesRpc.OrderBase.Builder value
+ * @param inRpcOrder a TradeTypesRpc.OrderBase.Builder value
*/
public static void setText(OrderBase inOrder,
TradeTypesRpc.OrderBase inRpcOrder)
@@ -1229,7 +1229,7 @@ public static void setText(OrderBase inOrder,
* Set the execution destination from the given RPC order.
*
* @param inOrder a NewOrReplaceOrder value
- * @param inBuilder a TradeTypesRpc.OrderBase.Builder value
+ * @param inRpcOrder a TradeTypesRpc.OrderBase.Builder value
*/
public static void setExecutionDestination(NewOrReplaceOrder inOrder,
TradeTypesRpc.OrderBase inRpcOrder)
@@ -1258,7 +1258,7 @@ public static void setExecutionDestination(NewOrReplaceOrder inOrder,
* Set the peg-to-midpoint value from the given RPC order.
*
* @param inOrder a NewOrReplaceOrder value
- * @param inBuilder a TradeTypesRpc.OrderBase.Builder value
+ * @param inRpcOrder a TradeTypesRpc.OrderBase.Builder value
*/
public static void setPegToMidpoint(NewOrReplaceOrder inOrder,
TradeTypesRpc.OrderBase inRpcOrder)
@@ -1269,7 +1269,7 @@ public static void setPegToMidpoint(NewOrReplaceOrder inOrder,
* Set the broker algo from the given RPC order.
*
* @param inOrder a NewOrReplaceOrder value
- * @param inBuilder a TradeTypesRpc.OrderBase.Builder value
+ * @param inRpcOrder a TradeTypesRpc.OrderBase.Builder value
*/
public static void setBrokerAlgo(NewOrReplaceOrder inOrder,
TradeTypesRpc.OrderBase inRpcOrder)
@@ -1488,7 +1488,7 @@ public static Optional getBrokerId(Object inObject)
/**
* Get the broker order ID from the given RPC report.
*
- * @param inObject a TradeTypesRpc.Report value
+ * @param inReport a TradeTypesRpc.Report value
* @return an Optional<OrderID> value
*/
public static Optional getBrokerOrderId(TradeTypesRpc.Report inReport)
@@ -1764,7 +1764,7 @@ public static TradeMessage getTradeMessage(TradeMessageListenerResponse inRespon
/**
* Get the trade message value from the given RPC trade message.
*
- * @param inReport a TradeTypesRpc.TradeMessage value
+ * @param inRpcTradeMessage a TradeTypesRpc.TradeMessage value
* @return a TradeMessage value
*/
public static TradeMessage getTradeMessage(TradeTypesRpc.TradeMessage inRpcTradeMessage)
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/dao/DatabaseIDFactory.java b/trade/trade-server/src/main/java/org/marketcetera/trade/dao/DatabaseIDFactory.java
index c5fce41f60..f3a55f2faf 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/dao/DatabaseIDFactory.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/dao/DatabaseIDFactory.java
@@ -49,7 +49,7 @@ public long getCacheQuantity()
/**
* Sets the cacheQuantity value.
*
- * @param a long value
+ * @param inCacheQuantity a long value
*/
public void setCacheQuantity(long inCacheQuantity)
{
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/dao/PersistentDatabaseID.java b/trade/trade-server/src/main/java/org/marketcetera/trade/dao/PersistentDatabaseID.java
index 1885dcd40f..deb882a827 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/dao/PersistentDatabaseID.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/dao/PersistentDatabaseID.java
@@ -36,7 +36,7 @@ public long getNextAllowedId()
/**
* Sets the nextAllowedId value.
*
- * @param a long value
+ * @param inNextAllowedId a long value
*/
public void setNextAllowedId(long inNextAllowedId)
{
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/dao/PersistentReport.java b/trade/trade-server/src/main/java/org/marketcetera/trade/dao/PersistentReport.java
index 6945b93077..a537cf4cd4 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/dao/PersistentReport.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/dao/PersistentReport.java
@@ -123,7 +123,6 @@ public TradeMessage getTradeMessage()
* Converts the report into a system report instance.
*
* @return the system report instance.
- * @throws ReportPersistenceException if there were errors converting the message from its persistent representation to system report instance
*/
public ReportBase toReport()
{
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/event/connector/IncomingTradeMessageBroadcastConnector.java b/trade/trade-server/src/main/java/org/marketcetera/trade/event/connector/IncomingTradeMessageBroadcastConnector.java
index 28f02a2f16..08cc7061e3 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/event/connector/IncomingTradeMessageBroadcastConnector.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/event/connector/IncomingTradeMessageBroadcastConnector.java
@@ -27,7 +27,7 @@ public class IncomingTradeMessageBroadcastConnector
/**
* Receive the incoming FIX application message.
*
- * @param inEvent an IncomingFixAppMessageEvent value
+ * @param inTradeMessage a TradeMessage value
*/
@Subscribe
public void receive(TradeMessage inTradeMessage)
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/impl/AccountOwnerStrategy.java b/trade/trade-server/src/main/java/org/marketcetera/trade/impl/AccountOwnerStrategy.java
index 582942ec96..bd2019c910 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/impl/AccountOwnerStrategy.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/impl/AccountOwnerStrategy.java
@@ -73,7 +73,7 @@ public AccountUserLookupProvider getAccountUserLookupProvider()
/**
* Sets the accountUserLookupProvider value.
*
- * @param an AccountUserLookupProvider value
+ * @param inAccountUserLookupProvider an AccountUserLookupProvider value
*/
public void setAccountUserLookupProvider(AccountUserLookupProvider inAccountUserLookupProvider)
{
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/impl/DefaultOwnerStrategy.java b/trade/trade-server/src/main/java/org/marketcetera/trade/impl/DefaultOwnerStrategy.java
index 408a59e429..520f052d57 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/impl/DefaultOwnerStrategy.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/impl/DefaultOwnerStrategy.java
@@ -62,7 +62,7 @@ public String getUsername()
/**
* Sets the username value.
*
- * @param a String value
+ * @param inUsername a String value
*/
public void setUsername(String inUsername)
{
@@ -80,7 +80,7 @@ public UserService getUserService()
/**
* Sets the userService value.
*
- * @param a UserService value
+ * @param inUserService a UserService value
*/
public void setUserService(UserService inUserService)
{
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/impl/OutgoingMessageLookupStrategy.java b/trade/trade-server/src/main/java/org/marketcetera/trade/impl/OutgoingMessageLookupStrategy.java
index e4a816bd49..d040da7b66 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/impl/OutgoingMessageLookupStrategy.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/impl/OutgoingMessageLookupStrategy.java
@@ -107,7 +107,7 @@ public PersistentOutgoingMessageDao getOutgoingMessageDao()
/**
* Sets the outgoingMessageDao value.
*
- * @param a PersistentOutgoingMessageDao value
+ * @param inOutgoingMessageDao a PersistentOutgoingMessageDao value
*/
public void setOutgoingMessageDao(PersistentOutgoingMessageDao inOutgoingMessageDao)
{
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/TradePnlServiceImpl.java b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/TradePnlServiceImpl.java
index dcbda65703..95036955bc 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/TradePnlServiceImpl.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/TradePnlServiceImpl.java
@@ -3,18 +3,31 @@
//
package org.marketcetera.trade.pnl;
+import javax.annotation.PostConstruct;
+
import org.marketcetera.admin.service.UserService;
import org.marketcetera.admin.user.PersistentUser;
+import org.marketcetera.core.PlatformServices;
import org.marketcetera.core.Preserve;
+import org.marketcetera.eventbus.EventBusService;
import org.marketcetera.persist.CollectionPageResponse;
+import org.marketcetera.trade.Instrument;
+import org.marketcetera.trade.UserID;
import org.marketcetera.trade.pnl.dao.CurrentPositionDao;
import org.marketcetera.trade.pnl.dao.ProfitAndLossDao;
import org.marketcetera.trade.pnl.dao.QPersistentCurrentPosition;
+import org.marketcetera.trade.pnl.event.PositionChangedEvent;
+import org.marketcetera.util.log.SLF4JLoggerProxy;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort;
+import org.springframework.stereotype.Component;
+import org.springframework.transaction.annotation.Propagation;
+import org.springframework.transaction.annotation.Transactional;
+
+import com.google.common.eventbus.Subscribe;
/* $License$ */
@@ -26,20 +39,21 @@
* @since $Release$
*/
@Preserve
-@org.springframework.stereotype.Component
+@Component
public class TradePnlServiceImpl
- implements org.marketcetera.trade.pnl.TradePnlService
+ implements TradePnlService
{
/**
* Requests positions for a user.
*
- * @param inUserID a org.marketcetera.trade.UserID value
- * @param inPageRequest a org.marketcetera.persist.PageRequest value
- * @returns a org.marketcetera.trade.pnl.CurrentPosition value
+ * @param inUserID a UserID value
+ * @param inPageRequest a PageRequest value
+ * @return a CollectionPageResponse<CurrentPosition> value
*/
@Override
- @org.springframework.transaction.annotation.Transactional(readOnly=true,propagation=org.springframework.transaction.annotation.Propagation.REQUIRED)
- public org.marketcetera.persist.CollectionPageResponse getCurrentPositions(org.marketcetera.trade.UserID inUserID,org.marketcetera.persist.PageRequest inPageRequest)
+ @Transactional(readOnly=true,propagation=Propagation.REQUIRED)
+ public CollectionPageResponse getCurrentPositions(UserID inUserID,
+ org.marketcetera.persist.PageRequest inPageRequest)
{
Sort sort = Sort.by(new Sort.Order(Sort.Direction.ASC,
QPersistentCurrentPosition.persistentCurrentPosition.symbol.getMetadata().getName()));
@@ -57,39 +71,45 @@ public org.marketcetera.persist.CollectionPageResponseorg.marketcetera.trade.UserID value
- * @param inInstrument a org.marketcetera.trade.Instrument value
- * @param inPageRequest a org.marketcetera.persist.PageRequest value
- * @returns a org.marketcetera.trade.pnl.ProfitAndLoss value
+ * @param inUserID a UserID value
+ * @param inInstrument a Instrument value
+ * @param inPageRequest a PageRequest value
+ * @return a CollectionPageResponse<ProfitAndLoss> value
*/
@Override
- @org.springframework.transaction.annotation.Transactional(readOnly=true,propagation=org.springframework.transaction.annotation.Propagation.REQUIRED)
- public org.marketcetera.persist.CollectionPageResponse getProfitAndLoss(org.marketcetera.trade.UserID inUserID,org.marketcetera.trade.Instrument inInstrument,org.marketcetera.persist.PageRequest inPageRequest)
+ @Transactional(readOnly=true,propagation=Propagation.REQUIRED)
+ public CollectionPageResponse getProfitAndLoss(UserID inUserID,
+ Instrument inInstrument,
+ org.marketcetera.persist.PageRequest inPageRequest)
{
throw new UnsupportedOperationException(); // TODO
}
/**
* Accept incoming PositionChangedEvent values.
+ *
+ * @param inPositionChangedEvent a PositionChangedEvent value
*/
- @com.google.common.eventbus.Subscribe
- public void accept(org.marketcetera.trade.pnl.event.PositionChangedEvent inPositionChangedEvent)
+ @Subscribe
+ public void accept(PositionChangedEvent inPositionChangedEvent)
{
throw new UnsupportedOperationException(); // TODO
}
/**
* Validate and start the object.
*/
- @javax.annotation.PostConstruct
+ @PostConstruct
public void start()
{
- org.marketcetera.util.log.SLF4JLoggerProxy.info(this,"Starting {}",org.marketcetera.core.PlatformServices.getServiceName(getClass()));
+ SLF4JLoggerProxy.info(this,
+ "Starting {}",
+ PlatformServices.getServiceName(getClass()));
eventBusService.register(this);
}
/**
* provides access to event services
*/
- @org.springframework.beans.factory.annotation.Autowired
- private org.marketcetera.eventbus.EventBusService eventBusService;
+ @Autowired
+ private EventBusService eventBusService;
/**
* provides access to user services
*/
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentCurrentPositionFactory.java b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentCurrentPositionFactory.java
index 4b5eef91f7..43847640f2 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentCurrentPositionFactory.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentCurrentPositionFactory.java
@@ -3,6 +3,10 @@
//
package org.marketcetera.trade.pnl.dao;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.trade.pnl.CurrentPosition;
+import org.marketcetera.trade.pnl.CurrentPositionFactory;
+
/* $License$ */
/**
@@ -12,28 +16,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class PersistentCurrentPositionFactory
- implements org.marketcetera.trade.pnl.CurrentPositionFactory
+ implements CurrentPositionFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentCurrentPosition instance.
+ * Create a new PersistentCurrentPosition instance.
*
- * @return a org.marketcetera.trade.pnl.dao.PersistentCurrentPosition value
+ * @return a PersistentCurrentPosition value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentCurrentPosition create()
+ public PersistentCurrentPosition create()
{
- return new org.marketcetera.trade.pnl.dao.PersistentCurrentPosition();
+ return new PersistentCurrentPosition();
}
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentCurrentPosition instance from the given object.
+ * Create a new PersistentCurrentPosition instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.dao.PersistentCurrentPosition value
- * @return a org.marketcetera.trade.pnl.dao.PersistentCurrentPosition value
+ * @param inCurrentPosition a CurrentPosition value
+ * @return a PersistentCurrentPosition value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentCurrentPosition create(org.marketcetera.trade.pnl.CurrentPosition inPersistentCurrentPosition)
+ public PersistentCurrentPosition create(CurrentPosition inCurrentPosition)
{
- return new org.marketcetera.trade.pnl.dao.PersistentCurrentPosition(inPersistentCurrentPosition);
+ return new PersistentCurrentPosition(inCurrentPosition);
}
}
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentLotFactory.java b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentLotFactory.java
index 7e97f63251..4cd4d70647 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentLotFactory.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentLotFactory.java
@@ -3,6 +3,10 @@
//
package org.marketcetera.trade.pnl.dao;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.trade.pnl.Lot;
+import org.marketcetera.trade.pnl.LotFactory;
+
/* $License$ */
/**
@@ -12,28 +16,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class PersistentLotFactory
- implements org.marketcetera.trade.pnl.LotFactory
+ implements LotFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentLot instance.
+ * Create a new PersistentLot instance.
*
- * @return a org.marketcetera.trade.pnl.dao.PersistentLot value
+ * @return a PersistentLot value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentLot create()
+ public PersistentLot create()
{
- return new org.marketcetera.trade.pnl.dao.PersistentLot();
+ return new PersistentLot();
}
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentLot instance from the given object.
+ * Create a new PersistentLot instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.dao.PersistentLot value
- * @return a org.marketcetera.trade.pnl.dao.PersistentLot value
+ * @param inLot a Lot value
+ * @return a PersistentLot value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentLot create(org.marketcetera.trade.pnl.Lot inPersistentLot)
+ public PersistentLot create(Lot inLot)
{
- return new org.marketcetera.trade.pnl.dao.PersistentLot(inPersistentLot);
+ return new PersistentLot(inLot);
}
}
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentPositionFactory.java b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentPositionFactory.java
index b23c7f6386..05c6e28e00 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentPositionFactory.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentPositionFactory.java
@@ -3,6 +3,10 @@
//
package org.marketcetera.trade.pnl.dao;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.trade.pnl.Position;
+import org.marketcetera.trade.pnl.PositionFactory;
+
/* $License$ */
/**
@@ -12,28 +16,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class PersistentPositionFactory
- implements org.marketcetera.trade.pnl.PositionFactory
+ implements PositionFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentPosition instance.
+ * Create a new PersistentPosition instance.
*
- * @return a org.marketcetera.trade.pnl.dao.PersistentPosition value
+ * @return a PersistentPosition value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentPosition create()
+ public PersistentPosition create()
{
- return new org.marketcetera.trade.pnl.dao.PersistentPosition();
+ return new PersistentPosition();
}
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentPosition instance from the given object.
+ * Create a new PersistentPosition instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.dao.PersistentPosition value
- * @return a org.marketcetera.trade.pnl.dao.PersistentPosition value
+ * @param inPosition a Position value
+ * @return a PersistentPosition value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentPosition create(org.marketcetera.trade.pnl.Position inPersistentPosition)
+ public PersistentPosition create(Position inPosition)
{
- return new org.marketcetera.trade.pnl.dao.PersistentPosition(inPersistentPosition);
+ return new PersistentPosition(inPosition);
}
}
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentProfitAndLossFactory.java b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentProfitAndLossFactory.java
index 9085435489..3a86d74b88 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentProfitAndLossFactory.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentProfitAndLossFactory.java
@@ -3,6 +3,10 @@
//
package org.marketcetera.trade.pnl.dao;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.trade.pnl.ProfitAndLoss;
+import org.marketcetera.trade.pnl.ProfitAndLossFactory;
+
/* $License$ */
/**
@@ -12,28 +16,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class PersistentProfitAndLossFactory
- implements org.marketcetera.trade.pnl.ProfitAndLossFactory
+ implements ProfitAndLossFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentProfitAndLoss instance.
+ * Create a new PersistentProfitAndLoss instance.
*
- * @return a org.marketcetera.trade.pnl.dao.PersistentProfitAndLoss value
+ * @return a PersistentProfitAndLoss value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentProfitAndLoss create()
+ public PersistentProfitAndLoss create()
{
- return new org.marketcetera.trade.pnl.dao.PersistentProfitAndLoss();
+ return new PersistentProfitAndLoss();
}
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentProfitAndLoss instance from the given object.
+ * Create a new PersistentProfitAndLoss instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.dao.PersistentProfitAndLoss value
- * @return a org.marketcetera.trade.pnl.dao.PersistentProfitAndLoss value
+ * @param inProfitAndLoss a ProfitAndLoss value
+ * @return a PersistentProfitAndLoss value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentProfitAndLoss create(org.marketcetera.trade.pnl.ProfitAndLoss inPersistentProfitAndLoss)
+ public PersistentProfitAndLoss create(ProfitAndLoss inProfitAndLoss)
{
- return new org.marketcetera.trade.pnl.dao.PersistentProfitAndLoss(inPersistentProfitAndLoss);
+ return new PersistentProfitAndLoss(inProfitAndLoss);
}
}
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentTradeFactory.java b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentTradeFactory.java
index e4f9689aae..6a76af1d37 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentTradeFactory.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentTradeFactory.java
@@ -3,6 +3,10 @@
//
package org.marketcetera.trade.pnl.dao;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.trade.pnl.Trade;
+import org.marketcetera.trade.pnl.TradeFactory;
+
/* $License$ */
/**
@@ -12,28 +16,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class PersistentTradeFactory
- implements org.marketcetera.trade.pnl.TradeFactory
+ implements TradeFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentTrade instance.
+ * Create a new PersistentTrade instance.
*
- * @return a org.marketcetera.trade.pnl.dao.PersistentTrade value
+ * @return a PersistentTrade value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentTrade create()
+ public PersistentTrade create()
{
- return new org.marketcetera.trade.pnl.dao.PersistentTrade();
+ return new PersistentTrade();
}
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentTrade instance from the given object.
+ * Create a new PersistentTrade instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.dao.PersistentTrade value
- * @return a org.marketcetera.trade.pnl.dao.PersistentTrade value
+ * @param inTrade a Trade value
+ * @return a PersistentTrade value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentTrade create(org.marketcetera.trade.pnl.Trade inPersistentTrade)
+ public PersistentTrade create(Trade inTrade)
{
- return new org.marketcetera.trade.pnl.dao.PersistentTrade(inPersistentTrade);
+ return new PersistentTrade(inTrade);
}
}
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentUserTrade.java b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentUserTrade.java
index 6942519fd6..f7d79e61ea 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentUserTrade.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentUserTrade.java
@@ -6,7 +6,7 @@
/* $License$ */
/**
- * Provides a user-centric view of a {@link Trade}.
+ * Provides a user-centric view of a {@link org.marketcetera.trade.pnl.UserTrade}.
*
* @author Colin DuPlantis
* @version $Id$
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentUserTradeFactory.java b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentUserTradeFactory.java
index 9cc84f6eed..52c5073774 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentUserTradeFactory.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/PersistentUserTradeFactory.java
@@ -3,6 +3,10 @@
//
package org.marketcetera.trade.pnl.dao;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.trade.pnl.UserTrade;
+import org.marketcetera.trade.pnl.UserTradeFactory;
+
/* $License$ */
/**
@@ -12,28 +16,29 @@
* @version $Id$
* @since $Release$
*/
+@Preserve
public class PersistentUserTradeFactory
- implements org.marketcetera.trade.pnl.UserTradeFactory
+ implements UserTradeFactory
{
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentUserTrade instance.
+ * Create a new PersistentUserTrade instance.
*
- * @return a org.marketcetera.trade.pnl.dao.PersistentUserTrade value
+ * @return a PersistentUserTrade value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentUserTrade create()
+ public PersistentUserTrade create()
{
- return new org.marketcetera.trade.pnl.dao.PersistentUserTrade();
+ return new PersistentUserTrade();
}
/**
- * Create a new org.marketcetera.trade.pnl.dao.PersistentUserTrade instance from the given object.
+ * Create a new PersistentUserTrade instance from the given object.
*
- * @param inObject a org.marketcetera.trade.pnl.dao.PersistentUserTrade value
- * @return a org.marketcetera.trade.pnl.dao.PersistentUserTrade value
+ * @param inUserTrade a UserTrade value
+ * @return a PersistentUserTrade value
*/
@Override
- public org.marketcetera.trade.pnl.dao.PersistentUserTrade create(org.marketcetera.trade.pnl.UserTrade inPersistentUserTrade)
+ public PersistentUserTrade create(UserTrade inUserTrade)
{
- return new org.marketcetera.trade.pnl.dao.PersistentUserTrade(inPersistentUserTrade);
+ return new PersistentUserTrade(inUserTrade);
}
}
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/UserTradeDao.java b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/UserTradeDao.java
index 8a44860d8e..e28d2ce08f 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/UserTradeDao.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/pnl/dao/UserTradeDao.java
@@ -3,16 +3,22 @@
//
package org.marketcetera.trade.pnl.dao;
+import org.marketcetera.core.Preserve;
+import org.marketcetera.trade.pnl.UserTrade;
+import org.springframework.data.jpa.repository.JpaRepository;
+import org.springframework.data.querydsl.QuerydslPredicateExecutor;
+
/* $License$ */
/**
- * Provides a user-centric view of a {@link Trade}.
+ * Providers data store access to {@link UserTrade} objects.
*
* @author Colin DuPlantis
* @version $Id$
* @since $Release$
*/
+@Preserve
public interface UserTradeDao
- extends org.springframework.data.jpa.repository.JpaRepository,org.springframework.data.querydsl.QuerydslPredicateExecutor
+ extends JpaRepository,QuerydslPredicateExecutor
{
}
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/service/impl/MessageOwnerServiceImpl.java b/trade/trade-server/src/main/java/org/marketcetera/trade/service/impl/MessageOwnerServiceImpl.java
index 9211e09072..7a9d2b0b78 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/service/impl/MessageOwnerServiceImpl.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/service/impl/MessageOwnerServiceImpl.java
@@ -183,7 +183,7 @@ public long getOrderCacheSize()
/**
* Sets the orderCacheSize value.
*
- * @param a long value
+ * @param inOrderCacheSize a long value
*/
public void setOrderCacheSize(long inOrderCacheSize)
{
@@ -201,7 +201,7 @@ public List getIdentifyOwnerStrategies()
/**
* Set the identifyOwnerStrategies value.
*
- * @param a List<IdentifyOwnerStrategy> value
+ * @param inIdentifyOwnerStrategies a List<IdentifyOwnerStrategy> value
*/
public void setIdentifyOwnerStrategies(List inIdentifyOwnerStrategies)
{
diff --git a/trade/trade-server/src/main/java/org/marketcetera/trade/service/impl/ReportServiceImpl.java b/trade/trade-server/src/main/java/org/marketcetera/trade/service/impl/ReportServiceImpl.java
index 51a03d58c7..03ea1ea957 100644
--- a/trade/trade-server/src/main/java/org/marketcetera/trade/service/impl/ReportServiceImpl.java
+++ b/trade/trade-server/src/main/java/org/marketcetera/trade/service/impl/ReportServiceImpl.java
@@ -1130,7 +1130,7 @@ public int getCacheSize()
/**
* Sets the cacheSize value.
*
- * @param an int value
+ * @param inCacheSize an int value
*/
public void setCacheSize(int inCacheSize)
{
diff --git a/util/src/main/java/org/marketcetera/util/except/package.html b/util/src/main/java/org/marketcetera/util/except/package.html
index 31eed21c94..c65914b54c 100644
--- a/util/src/main/java/org/marketcetera/util/except/package.html
+++ b/util/src/main/java/org/marketcetera/util/except/package.html
@@ -69,7 +69,7 @@ General usage
locale-specific string comparison. For example:
-@Test
+@Test
public void findWorks()
{
try {
@@ -145,39 +145,39 @@ Thread interruption
-
The exception classes {@link
+ The exception classes {@link
org.marketcetera.util.except.I18NInterruptedException} and {@link
org.marketcetera.util.except.I18NInterruptedRuntimeException}, which
can be thrown to indicate unsuccessful task completion due to
interruption. These are subclasses of {@link
org.marketcetera.util.except.I18NException} and {@link
org.marketcetera.util.except.I18NRuntimeException} respectively, and
-include a default i18n message for interruption.
+include a default i18n message for interruption.
-
The wrapping utilities in {@link
+ The wrapping utilities in {@link
org.marketcetera.util.except.ExceptUtils} use these classes instead of
the generic {@link org.marketcetera.util.except.I18NException} and
{@link org.marketcetera.util.except.I18NRuntimeException} when the
wrapped exception indicates an interruption; these utilities also
-ensure that, in such a case, the interrupted flag is set.
+ensure that, in such a case, the interrupted flag is set.
-
The exception swallowing utilities in {@link
+ The exception swallowing utilities in {@link
org.marketcetera.util.except.ExceptUtils} also set the interrupted
flag if the exception being swallowed indicates an
-interruption.
+interruption.
-
{@link org.marketcetera.util.except.I18NInterruptedException}
+ {@link org.marketcetera.util.except.I18NInterruptedException}
and {@link
org.marketcetera.util.except.I18NInterruptedRuntimeException} provide
static methods such as {@link
org.marketcetera.util.except.I18NInterruptedException#checkInterruption()}
-that make it easy for your code to check if interruption has occured
+that make it easy for your code to check if interruption has occurred
(i.e. the interrupt flag is set) and, if so, throw the exception on
-your behalf (while leaving the flag set).
+your behalf (while leaving the flag set).
-
{@link org.marketcetera.util.except.ExceptUtils} provides similar
+ {@link org.marketcetera.util.except.ExceptUtils} provides similar
static methods that throw an {@link
-java.lang.InterruptedException} (the flag remains set).
+java.lang.InterruptedException} (the flag remains set).