Merge branch 'master' of github.com:corda/samples-java

Author: anixon604

Tokens/spaceships-javaAPIs/README.md

@@ -10,7 +10,7 @@ tokens_release_version = '1.2-SNAPSHOT'
 You must download the latest source [here](https://github.com/corda/token-sdk) and then run the gradle task 'publishToMavenLocal'
 
 ---
-This cordapp demonstrates the new Java Apis released with TokenSDK 1.2
+This CorDapp demonstrates the new Java APIs released with Token SDK 1.2
 
 For an exploratory overview of usage, checkout the following blog post: [here](https://medium.com/corda/corda-tokens-made-easy-with-new-java-apis-83095693d72)
 
@@ -36,7 +36,7 @@ Additionally two new Java Builder classes have been added to allow easy creation
 - FungibleTokenBuilder
 - NonFungibleTokenBuilder
 
-The Cordapp will allow International Planetary Council (IPC) residents to use their local currencies to either purchase unique spaceships (represented by NonFungibleToken) OR invest in partial ownership of a spaceship (represented by a FungibleToken). 
+The CorDapp will allow International Planetary Council (IPC) residents to use their local currencies to either purchase unique spaceships (represented by NonFungibleToken) OR invest in partial ownership of a spaceship (represented by a FungibleToken). 
 
 Examples of the new Java APIs will be used throughout and identified as such.
 
@@ -47,7 +47,7 @@ Examples of the new Java APIs will be used throughout and identified as such.
 
 ### Flows
 
-Flows are executed through the `FlowTests` class in the workflows module. They can also be run through the CrashShell.
+Flows are executed through the `FlowTests` class in the workflows module. They can also be run through the CRaSH shell.
 
 
 ## Pre-Requisites

Tokens/spaceships-javaAPIs/contracts/src/main/java/net/corda/examples/spaceships/states/SpaceshipTokenType.java

@@ -98,9 +98,7 @@ public List<Party> getMaintainers() {
     public UniqueIdentifier getLinearId() {
         return linearId;
     }
-
-
-
+    
     /* This method returns a TokenPointer by using the linear Id of the evolvable state */
     public TokenPointer<SpaceshipTokenType> toPointer(){
         LinearPointer<SpaceshipTokenType> linearPointer = new LinearPointer<>(linearId, SpaceshipTokenType.class);

Tokens/spaceships-javaAPIs/workflows/src/main/java/net/corda/examples/spaceships/flows/BuySpaceshipFlows.java

@@ -35,7 +35,7 @@
  * To achieve this the steps are:
  * 1. Buyer requests the value/sale price of the ship he wants to purchase identified by UUID
  * 2. Seller queries his inventory of ships and grabs the value of the associated UUID and sends to Buyer
- * 3. Buyer checks to see if he has the money to pay - if not throws exception which ends the flow.
+ * 3. Buyer checks to see if he has the money to pay - if not throws exception which ends the flow
  * 4. Seller sends the transaction of ownership (the tx that created his ownership token) and sends it to Buyer
  * 5. Buyer creates transaction with the required currency tokens going to seller, and the ship token going to buyer
  * 6. Transaction is signed and finalised
@@ -69,21 +69,21 @@ public SignedTransaction call() throws FlowException {
 
             paymentAmount = shipValue; // first we will try to pay in the native currency of the ship's value
 
-            // check if we have enough funds to afford this currency and amount
+            // Check if we have enough funds to afford this currency and amount
             // tokenBalance returns Amount<TokenType> which represents the quantity of this TokenType (currency) in our vault
             int fundsAvailable = QueryUtilities.tokenBalance(vaultService, shipValue.getToken()).compareTo(paymentAmount);
 
             if (fundsAvailable >= 0) { // we have enough funds and will go through with the purchase
                 processSale = true;
             } else { // we do NOT have enough, in THAT tokenType but check if we can pay in some other currency using exchange rate
 
-                // creates a set of all tokenTypes we are holding
+                // Creates a set of all tokenTypes we are holding
                 Set<TokenType> heldTokenTypes = vaultService.queryBy(FungibleToken.class).getStates().stream()
                         .map(it -> it.getState().getData().getTokenType())
                         .collect(Collectors.toSet());
                 heldTokenTypes.remove(shipValue.getToken()); // remove this as it's already been checked
 
-                // iterate over all the different TokenTypes (currencies) we hold to see if any have enough value against
+                // Iterate over all the different TokenTypes (currencies) we hold to see if any have enough value against
                 // the listed exchange rate (defined in FlowHelpers interface)
                 for (TokenType currentTokenType : heldTokenTypes) {
                     paymentAmount = FlowHelpers.exchangeCurrency(shipValue, currentTokenType);
@@ -112,7 +112,7 @@ public SignedTransaction call() throws FlowException {
              * We record the transaction in OUR vault so that the TransactionBuilder can access it.
              * Important: make sure you have the argument StatesToRecord.ALL_VISIBLE as the default recordTransactions will only
              * record states in the transaction which are RELEVANT (i.e. which we participated in) this is not 'our' transaction
-             * so we need to that argument ALL_VISIBLE.
+             * so we need that argument ALL_VISIBLE.
              */
             getServiceHub().recordTransactions(StatesToRecord.ALL_VISIBLE, Collections.singletonList(shipTokenTransaction));
             NonFungibleToken shipNFT = shipTokenTransaction.getCoreTransaction().outputsOfType(NonFungibleToken.class).get(0);
@@ -123,15 +123,15 @@ public SignedTransaction call() throws FlowException {
                     // here we are generating input and output states which send the correct amount to the seller, and any change back to buyer
                     .generateMove(Collections.singletonList(new Pair<>(seller, paymentAmount)), getOurIdentity());
 
-            // Build the transaction which transfers the curreny tokens AND the spaceship token, in a single transaction
+            // Build the transaction which transfers the currency tokens AND the spaceship token, in a single transaction
             TransactionBuilder txBuilder = new TransactionBuilder(notary);
             MoveTokensUtilities.addMoveNonFungibleTokens(txBuilder, getServiceHub(), shipTokenPointer, getOurIdentity());
             MoveTokensUtilities.addMoveTokens(txBuilder, selectedTokens.getFirst(), selectedTokens.getSecond());
 
             SignedTransaction ptx = getServiceHub().signInitialTransaction(txBuilder);
             SignedTransaction stx = subFlow(new CollectSignaturesFlow(ptx, Collections.singletonList(sellerSession)));
 
-            // update the distribution list
+            // Update the distribution list
             subFlow(new UpdateDistributionListFlow(stx));
             return subFlow(new ObserverAwareFinalityFlow(stx, Collections.singletonList(sellerSession)));
         }
@@ -148,11 +148,11 @@ public BuySpaceshipResponder(FlowSession counterpartySession) {
         @Suspendable
         @Override
         public Void call() throws FlowException {
-            // receive request for value of the given shipId
+            // Receive request for value of the given shipId
             String shipId = counterpartySession.receive(String.class).unwrap(it -> it);
             UUID shipUUID = UUID.fromString(shipId);
 
-//            // Get the state definition from vault to grab the value
+            // Get the state definition from vault to grab the value
             SpaceshipTokenType spaceshipTokenType = FlowHelpers.uuidToSpaceShipTokenType(getServiceHub().getVaultService(), shipUUID);
 
             // (Step 1 - Respond with value) send back value

Tokens/spaceships-javaAPIs/workflows/src/main/java/net/corda/examples/spaceships/flows/FlowHelpers.java

@@ -37,7 +37,7 @@ static Amount<TokenType> exchangeCurrency(Amount<TokenType> amount, TokenType ta
     }
 
     /**
-     * ParseValueFromString takes in a String representation of an Amount (useful for terminal / UI input)
+     * parseAmountFromString takes in a String representation of an Amount (useful for terminal / UI input)
      * and returns the correct object.
      * @param value
      * @return

Tokens/spaceships-javaAPIs/workflows/src/main/java/net/corda/examples/spaceships/flows/InvestSpaceshipFlows.java

@@ -58,7 +58,7 @@ public sharesOwnedInSpaceshipResponder(FlowSession counterpartySession) {
         @Suspendable
         @Override
         public Void call() throws FlowException {
-            // receive request for value of the given shipId
+            // Receive request for value of the given shipId
             String shipId = counterpartySession.receive(String.class).unwrap(it -> it);
             UUID shipUUID = UUID.fromString(shipId);
 

Tokens/spaceships-javaAPIs/workflows/src/main/java/net/corda/examples/spaceships/flows/IssueSpaceshipFlows.java

@@ -67,14 +67,14 @@ public TokenizeFungibleSpaceship(Party holder, String model, String planetOfOrig
         public SignedTransaction call() throws FlowException {
             final Party manufacturer = getOurIdentity(); // node that tokenizes assumed to be manufacturer
 
-            //NotaryUtilities allows you to set a strategy for notary selection - otherwise you can default to firstnotary, or random
+            // NotaryUtilities allows you to set a strategy for notary selection - otherwise you can default to firstnotary, or random
             final Party notary = NotaryUtilities.getPreferredNotary(getServiceHub());
 
             /**
              * Create the evolvableTokenState
              *
              * CreateEvolvableTokens() will behind the scenes commit our token definition to the ledgers
-             * of the any maintainers specified in the SpaceshipTokenState (in our case the manufacturer) as well as any observers we pass in as an
+             * of any maintainers specified in the SpaceshipTokenState (in our case the manufacturer) as well as any observers we pass in as an
              * optional argument - we have not passed in any observers to CreateEvolvableTokens()
              */
             SpaceshipTokenType evolvableSpaceshipToken = new SpaceshipTokenType(manufacturer, model, planetOfOrigin, seatingCapacity, value, true);
@@ -102,7 +102,7 @@ public SignedTransaction call() throws FlowException {
 
     /**
      * A NonFungible Spaceship is one where there is only ONE holder (it can not be split or merged)
-     * - instances of this type of token will be used ownership of UNIQUE spaceships.
+     * - instances of this type of token will be used for ownership of UNIQUE spaceships.
      */
     @StartableByRPC
     class TokenizeNonFungibleSpaceship extends FlowLogic<SignedTransaction> {
@@ -134,7 +134,7 @@ public TokenizeNonFungibleSpaceship(Party holder, String model, String planetOfO
         public SignedTransaction call() throws FlowException {
             final Party manufacturer = getOurIdentity(); // node that tokenizes assumed to be manufacturer
 
-            //NotaryUtilities allows you to set a strategy for notary selection - otherwise you can default to first notary, or random
+            // NotaryUtilities allows you to set a strategy for notary selection - otherwise you can default to first notary, or random
             final Party notary = NotaryUtilities.getPreferredNotary(getServiceHub());
 
             /**

Tokens/spaceships-javaAPIs/workflows/src/main/java/net/corda/examples/spaceships/flows/UtilityFlows.java

@@ -94,13 +94,13 @@ public Amount<TokenType> call() throws FlowException {
 
             Set<TokenType> tokenTypesAvailable = fetchTokenTypes(FlowHelpers.rates.keySet());
 
-            // remove excluded Tokens (will not be in calculation)
+            // Remove excluded Tokens (will not be in calculation)
             if (exclusionList != null) tokenTypesAvailable.removeAll(exclusionList);
 
             List<Amount<TokenType>> amountsOfOutputTokenType = new ArrayList<>();
             tokenTypesAvailable.forEach(it -> {
                 Amount<TokenType> amountOfCurrentToken = QueryUtilities.tokenBalance(vs, it);
-                // convert to output currency
+                // Convert to output currency
                 if (!it.equals(outputTokenType)) {
                     amountOfCurrentToken = FlowHelpers.exchangeCurrency(amountOfCurrentToken, outputTokenType);
                 }