Merge pull request #291 from wimvelzeboer/feature/cleanUp

Correct typo's and casing of object names

Author: ImJohnMDaniel

sfdx-source/apex-common/main/classes/fflib_Application.cls

@@ -118,7 +118,7 @@ public virtual class fflib_Application
 	}
 
 	/**
-	 * Simple Service Factory implementaiton
+	 * Simple Service Factory implementation
 	 **/
 	public virtual class ServiceFactory
 	{
@@ -154,7 +154,7 @@ public virtual class fflib_Application
 			if(m_serviceInterfaceTypeByMockService.containsKey(serviceInterfaceType))
 				return m_serviceInterfaceTypeByMockService.get(serviceInterfaceType);
 
-			// Create an instance of the type impleneting the given interface
+			// Create an instance of the type implementing the given interface
 			Type serviceImpl = m_serviceInterfaceTypeByServiceImplType.get(serviceInterfaceType);
 			if(serviceImpl==null)
 				throw new DeveloperException('No implementation registered for service interface ' + serviceInterfaceType.getName());	
@@ -178,7 +178,7 @@ public virtual class fflib_Application
 
 		/**
 		 * Consturcts a Selector Factory linking SObjectType's with Apex Classes implement the fflib_ISObjectSelector interface
-		 *   Note that the factory does not chekc the given Apex Classes implement the interface
+		 *   Note that the factory does not check the given Apex Classes implement the interface
 		 *     currently this is not possible in Apex.
 		 *
 		 * @Param sObjectBySelectorType Map of SObjectType's to Selector Apex Classes
@@ -191,7 +191,7 @@ public virtual class fflib_Application
 
 		/**
 		 * Creates a new instance of the associated Apex Class implementing fflib_ISObjectSelector
-		 *   for the given SObjectType, or if provided via setMock returns the Mock implementaton
+		 *   for the given SObjectType, or if provided via setMock returns the Mock implementation
 		 *
 		 * @param sObjectType An SObjectType token, e.g. Account.SObjectType
 		 **/
@@ -241,9 +241,9 @@ public virtual class fflib_Application
 		 *   Account selector to query the related Account records, e.g.
 		 *
 		 *     List<Account> accounts = 
-		 *        (List<Account>) Applicaiton.Selector.selectByRelationship(myOpps, Opportunity.AccountId);
+		 *        (List<Account>) Application.Selector.selectByRelationship(myOpps, Opportunity.AccountId);
 		 *
-		 * @param relatedRecords used to extract the related record Ids, e.g. Opportunty records
+		 * @param relatedRecords used to extract the related record Ids, e.g. Opportunity records
 		 * @param relationshipField field in the passed records that contains the relationship records to query, e.g. Opportunity.AccountId
 		 **/
 		public List<SObject> selectByRelationship(List<SObject> relatedRecords, SObjectField relationshipField)
@@ -277,7 +277,7 @@ public virtual class fflib_Application
 		protected Map<SObjectType, fflib_ISObjectDomain> m_sObjectByMockDomain;
 
 		/**
-		 * Consturcts a Domain factory, using an instance of the Selector Factory
+		 * Constructs a Domain factory, using an instance of the Selector Factory
 		 *   and a map of Apex classes implementing fflib_ISObjectDomain by SObjectType
 		 *   Note this will not check the Apex classes provided actually implement the interfaces
 		 *     since this is not possible in the Apex runtime at present
@@ -308,12 +308,12 @@ public virtual class fflib_Application
 		}	
 
 		/**
-		 * Dynamically constructs an instace of the Domain class for the given records
+		 * Dynamically constructs an instance of the Domain class for the given records
 		 *   Will return a Mock implementation if one has been provided via setMock
 		 *
-		 * @param records A concreate list (e.g. List<Account> vs List<SObject>) of records
+		 * @param records A concrete list (e.g. List<Account> vs List<SObject>) of records
 		 * @exception Throws an exception if the SObjectType cannot be determined from the list 
-		 *              or the constructor for Domain class was not registered for the SOBjectType
+		 *              or the constructor for Domain class was not registered for the SObjectType
 		 **/
 		public virtual fflib_ISObjectDomain newInstance(List<SObject> records)
 		{
@@ -337,7 +337,7 @@ public virtual class fflib_Application
 		}	
 
 		/**
-		 * Dynamically constructs an instace of the Domain class for the given records and SObjectType
+		 * Dynamically constructs an instance of the Domain class for the given records and SObjectType
 		 *   Will return a Mock implementation if one has been provided via setMock
 		 *
 		 * @param records A list records

sfdx-source/apex-common/main/classes/fflib_ISObjectUnitOfWork.cls

@@ -43,29 +43,29 @@ public interface fflib_ISObjectUnitOfWork
     void registerNew(List<SObject> records);
     /**
      * Register a newly created SObject instance to be inserted when commitWork is called,
-     *   you may also provide a reference to the parent record instance (should also be registered as new separatly)
+     *   you may also provide a reference to the parent record instance (should also be registered as new separately)
      *
      * @param record A newly created SObject instance to be inserted during commitWork
      * @param relatedToParentField A SObjectField reference to the child field that associates the child record with its parent
-     * @param relatedToParentRecord A SObject instance of the parent record (should also be registered as new separatly)
+     * @param relatedToParentRecord A SObject instance of the parent record (should also be registered as new separately)
      **/
-    void registerNew(SObject record, Schema.sObjectField relatedToParentField, SObject relatedToParentRecord);
+    void registerNew(SObject record, Schema.SObjectField relatedToParentField, SObject relatedToParentRecord);
     /**
      * Register a relationship between two records that have yet to be inserted to the database. This information will be
      *  used during the commitWork phase to make the references only when related records have been inserted to the database.
      *
      * @param record An existing or newly created record
-     * @param relatedToField A SObjectField referene to the lookup field that relates the two records together
-     * @param relatedTo A SOBject instance (yet to be commited to the database)
+     * @param relatedToField A SObjectField reference to the lookup field that relates the two records together
+     * @param relatedTo A SObject instance (yet to be committed to the database)
      */
-    void registerRelationship(SObject record, Schema.sObjectField relatedToField, SObject relatedTo);
+    void registerRelationship(SObject record, Schema.SObjectField relatedToField, SObject relatedTo);
     /**
      * Registers a relationship between a record and a Messaging.Email where the record has yet to be inserted
      *  to the database.  This information will be
      *  used during the commitWork phase to make the references only when related records have been inserted to the database.
      *
      * @param a single email message instance
-     * @param relatedTo A SOBject instance (yet to be commited to the database)
+     * @param relatedTo A SObject instance (yet to be committed to the database)
      */
     void registerRelationship(Messaging.SingleEmailMessage email, SObject relatedTo);
     /**
@@ -75,13 +75,13 @@ public interface fflib_ISObjectUnitOfWork
      * @param record An existing or newly created record
      * @param relatedToField A SObjectField reference to the lookup field that relates the two records together
      * @param externalIdField A SObjectField reference to a field on the target SObject that is marked as isExternalId
-     * @param externalId A Object representing the targetted value of the externalIdField in said lookup
+     * @param externalId A Object representing the targeted value of the externalIdField in said lookup
      *
      * Usage Example: uow.registerRelationship(recordSObject, record_sobject__c.relationship_field__c, lookup_sobject__c.external_id__c, 'abc123');
      *
      * Wraps putSObject, creating a new instance of the lookup sobject using the external id field and value.
      */
-     void registerRelationship(SObject record, Schema.sObjectField relatedToField, Schema.sObjectField externalIdField, Object externalId);
+     void registerRelationship(SObject record, Schema.SObjectField relatedToField, Schema.SObjectField externalIdField, Object externalId);
     /**
      * Register an existing record to be updated during the commitWork method
      *
@@ -99,7 +99,7 @@ public interface fflib_ISObjectUnitOfWork
      **/
     void registerDirty(List<SObject> records, List<SObjectField> dirtyFields);
     /**
-     * Register specific fields on record to be updated when work is commited
+     * Register specific fields on record to be updated when work is committed
      *
      * If the record has previously been registered as dirty, the dirty fields on the record in this call will overwrite
      * the values of the previously registered dirty record
@@ -110,13 +110,13 @@ public interface fflib_ISObjectUnitOfWork
     void registerDirty(SObject record, List<SObjectField> dirtyFields);
     /**
      * Register an existing record to be updated when commitWork is called,
-     *   you may also provide a reference to the parent record instance (should also be registered as new separatly)
+     *   you may also provide a reference to the parent record instance (should also be registered as new separately)
      *
      * @param record A newly created SObject instance to be inserted during commitWork
      * @param relatedToParentField A SObjectField reference to the child field that associates the child record with its parent
-     * @param relatedToParentRecord A SObject instance of the parent record (should also be registered as new separatly)
+     * @param relatedToParentRecord A SObject instance of the parent record (should also be registered as new separately)
      **/
-    void registerDirty(SObject record, Schema.sObjectField relatedToParentField, SObject relatedToParentRecord);
+    void registerDirty(SObject record, Schema.SObjectField relatedToParentField, SObject relatedToParentRecord);
     /**
      * Register a list of existing records to be updated during the commitWork method
      *
@@ -168,7 +168,7 @@ public interface fflib_ISObjectUnitOfWork
     /**
      * Register a list of existing records to be deleted and removed from the recycle bin during the commitWork method
      *
-     * @param records A list of existing records
+     * @param record A list of existing records
      **/
     void registerPermanentlyDeleted(SObject record);
     /**