Deprecating ProjectContext.getBuildFile() (#793)

* Deprecating ProjectContext

* updating description text

---------

Co-authored-by: Fabian Krüger <[email protected]>

Author: sanagaraj-pivotal

components/sbm-core/src/main/java/org/springframework/sbm/engine/context/ProjectContext.java

@@ -72,6 +72,14 @@ private Module mapToModule(BuildFile buildFile) {
         return new Module(buildFileName, buildFile, projectRootDirectory, modulePath, getProjectResources(), javaRefactoringFactory, basePackageCalculator, javaParser, executionContext);
     }
 
+    /**
+     * This is a legacy way of retrieving applications build file.
+     * This function does not generalise for situations where application is under a multi-module maven structure
+     * Use {@link #getApplicationModules()} instead of getBuildFile()
+     * If one would want to retrieve the root build file use:
+     * {@link #getApplicationModules()} and then call to get root module using: {@link ApplicationModules#getRootModule()}
+     * */
+    @Deprecated(forRemoval = true)
     public BuildFile getBuildFile() {
         return search(new RootBuildFileFilter());
     }