Skip to content

Commit

Permalink
Javadoc fixes/clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
@jodastephen
jodastephen committed Jul 18, 2018
1 parent 8bb251d commit 160d943
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 36 deletions.
24 changes: 15 additions & 9 deletions modules/product/src/main/java/com/opengamma/strata/product/bond/BondFuture.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,17 +109,19 @@ public final class BondFuture
* The first date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code firstNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
*/
@PropertyDefinition(get = "optional")
private final LocalDate firstDeliveryDate;
/**
* The last notice date.
* The last delivery date.
* <p>
* The last date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code lastNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
*/
@PropertyDefinition(get = "optional")
private final LocalDate lastDeliveryDate;
Expand Down Expand Up @@ -358,7 +360,8 @@ public LocalDate getLastNoticeDate() {
* The first date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code firstNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
* @return the optional value of the property, not null
*/
public Optional<LocalDate> getFirstDeliveryDate() {
Expand All @@ -367,12 +370,13 @@ public Optional<LocalDate> getFirstDeliveryDate() {

//-----------------------------------------------------------------------
/**
* Gets the last notice date.
* Gets the last delivery date.
* <p>
* The last date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code lastNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
* @return the optional value of the property, not null
*/
public Optional<LocalDate> getLastDeliveryDate() {
Expand Down Expand Up @@ -916,7 +920,8 @@ public Builder lastNoticeDate(LocalDate lastNoticeDate) {
* The first date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code firstNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
* @param firstDeliveryDate the new value
* @return this, for chaining, not null
*/
Expand All @@ -926,12 +931,13 @@ public Builder firstDeliveryDate(LocalDate firstDeliveryDate) {
}

/**
* Sets the last notice date.
* Sets the last delivery date.
* <p>
* The last date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code lastNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
* @param lastDeliveryDate the new value
* @return this, for chaining, not null
*/
Expand Down
30 changes: 18 additions & 12 deletions modules/product/src/main/java/com/opengamma/strata/product/bond/BondFutureSecurity.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ public final class BondFutureSecurity
/**
* The basket of deliverable bonds.
* <p>
* The underling which will be delivered in the future time is chosen from
* The underlying which will be delivered in the future time is chosen from
* a basket of underling securities. This must not be empty.
* <p>
* All of the underlying bonds must have the same notional and currency.
Expand Down Expand Up @@ -115,17 +115,19 @@ public final class BondFutureSecurity
* The first date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code firstNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
*/
@PropertyDefinition(get = "optional")
private final LocalDate firstDeliveryDate;
/**
* The last notice date.
* The last delivery date.
* <p>
* The last date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code lastNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
*/
@PropertyDefinition(get = "optional")
private final LocalDate lastDeliveryDate;
Expand Down Expand Up @@ -314,7 +316,7 @@ public Currency getCurrency() {
/**
* Gets the basket of deliverable bonds.
* <p>
* The underling which will be delivered in the future time is chosen from
* The underlying which will be delivered in the future time is chosen from
* a basket of underling securities. This must not be empty.
* <p>
* All of the underlying bonds must have the same notional and currency.
Expand Down Expand Up @@ -378,7 +380,8 @@ public LocalDate getLastNoticeDate() {
* The first date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code firstNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
* @return the optional value of the property, not null
*/
public Optional<LocalDate> getFirstDeliveryDate() {
Expand All @@ -387,12 +390,13 @@ public Optional<LocalDate> getFirstDeliveryDate() {

//-----------------------------------------------------------------------
/**
* Gets the last notice date.
* Gets the last delivery date.
* <p>
* The last date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code lastNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
* @return the optional value of the property, not null
*/
public Optional<LocalDate> getLastDeliveryDate() {
Expand Down Expand Up @@ -882,7 +886,7 @@ public Builder currency(Currency currency) {
/**
* Sets the basket of deliverable bonds.
* <p>
* The underling which will be delivered in the future time is chosen from
* The underlying which will be delivered in the future time is chosen from
* a basket of underling securities. This must not be empty.
* <p>
* All of the underlying bonds must have the same notional and currency.
Expand Down Expand Up @@ -976,7 +980,8 @@ public Builder lastNoticeDate(LocalDate lastNoticeDate) {
* The first date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code firstNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
* @param firstDeliveryDate the new value
* @return this, for chaining, not null
*/
Expand All @@ -986,12 +991,13 @@ public Builder firstDeliveryDate(LocalDate firstDeliveryDate) {
}

/**
* Sets the last notice date.
* Sets the last delivery date.
* <p>
* The last date on which the underlying is delivered.
* <p>
* If not specified, the date will be computed from {@code lastNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* {@code settlementDateOffset} in the first element of the delivery basket
* when the future is resolved.
* @param lastDeliveryDate the new value
* @return this, for chaining, not null
*/
Expand Down
18 changes: 3 additions & 15 deletions modules/product/src/main/java/com/opengamma/strata/product/bond/ResolvedBondFuture.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,17 +107,13 @@ public final class ResolvedBondFuture
* The first delivery date.
* <p>
* The first date on which the underlying is delivered.
* If not specified, this is computed from {@code firstNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
*/
@PropertyDefinition(validate = "notNull")
private final LocalDate firstDeliveryDate;
/**
* The last notice date.
* The last delivery date.
* <p>
* The last date on which the underlying is delivered.
* If not specified, this is computed from {@code lastNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
*/
@PropertyDefinition(validate = "notNull")
private final LocalDate lastDeliveryDate;
Expand Down Expand Up @@ -332,8 +328,6 @@ public LocalDate getLastNoticeDate() {
* Gets the first delivery date.
* <p>
* The first date on which the underlying is delivered.
* If not specified, this is computed from {@code firstNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* @return the value of the property, not null
*/
public LocalDate getFirstDeliveryDate() {
Expand All @@ -342,11 +336,9 @@ public LocalDate getFirstDeliveryDate() {

//-----------------------------------------------------------------------
/**
* Gets the last notice date.
* Gets the last delivery date.
* <p>
* The last date on which the underlying is delivered.
* If not specified, this is computed from {@code lastNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* @return the value of the property, not null
*/
public LocalDate getLastDeliveryDate() {
Expand Down Expand Up @@ -888,8 +880,6 @@ public Builder lastNoticeDate(LocalDate lastNoticeDate) {
* Sets the first delivery date.
* <p>
* The first date on which the underlying is delivered.
* If not specified, this is computed from {@code firstNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* @param firstDeliveryDate the new value, not null
* @return this, for chaining, not null
*/
Expand All @@ -900,11 +890,9 @@ public Builder firstDeliveryDate(LocalDate firstDeliveryDate) {
}

/**
* Sets the last notice date.
* Sets the last delivery date.
* <p>
* The last date on which the underlying is delivered.
* If not specified, this is computed from {@code lastNoticeDate} by using
* {@code settlementDateOffset} in the first element of the delivery basket.
* @param lastDeliveryDate the new value, not null
* @return this, for chaining, not null
*/
Expand Down

0 comments on commit 160d943

Please sign in to comment.