User Tools

Site Tools


principles:single_level_of_abstraction

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
principles:single_level_of_abstraction [2021-09-02 10:46] – old revision restored (2021-05-11 22:26) 65.21.179.175principles:single_level_of_abstraction [2021-10-18 22:03] (current) – +++ restored +++ christian
Line 1: Line 1:
 ====== Single Level of Abstraction (SLA) ====== ====== Single Level of Abstraction (SLA) ======
- 
 ===== Variants and Alternative Names ===== ===== Variants and Alternative Names =====
 +
  
   * One Level of Abstraction   * One Level of Abstraction
Line 19: Line 19:
 All statements of a method should belong to the same level of abstraction. If there is a statement which belongs to a lower level of abstraction, it should go to a private method which comprises statements on this level. Doing so will result in smaller methods. All statements of a method should belong to the same level of abstraction. If there is a statement which belongs to a lower level of abstraction, it should go to a private method which comprises statements on this level. Doing so will result in smaller methods.
  
-Often the body of a loop can be extracted resulting in a separate private method. Loops should ideally contain a single statement (usually a method call). Sometimes this is not achievable without other drawbacks but certainly large loop bodies can be considered a small+Often the body of a loop can be extracted resulting in a separate private method. Loops should ideally contain a single statement (usually a method call). Sometimes this is not achievable without other drawbacks but certainly large loop bodies can be considered a smell
  
 A further indicator for a missing method is the combination of a blank line, a comment and a block of code. In most of the cases the code block should go to a new private method. This also makes the comment obsolete as the new method carries a name which typically resembles the comment.  A further indicator for a missing method is the combination of a blank line, a comment and a block of code. In most of the cases the code block should go to a new private method. This also makes the comment obsolete as the new method carries a name which typically resembles the comment. 
  
-Sometimes extracting the method would result in the new method having a large number of parameters. Alternatively the parameters could be converted to fields of the class. But this would often result in bad [[glossary:cohesion]]. Because of that in such a case extracting a new class is the next step in adhering to the principle.+Sometimes extracting the method would result in the new method having a large number of parameters. Alternatively the parameters could be converted to fields of the class. But this would often result in bad [[glossary:cohesion]]. Because of that in such a case extracting a new class is the next step in adhering to the principle.  
  
 ===== Rationale ===== ===== Rationale =====
Line 36: Line 36:
  
 ===== Caveats ===== ===== Caveats =====
-An exception where it may be helpful not to adhere to the principle are certain algorithms. When implementing for instance a sorting algorithm, keeping the algorithm together can be considered more readable than splitting it up into several small functions. This is because certain algorithms are well known and splitting them up may disguise them. A suitable compromise has to be found in such a case. +See section [[#contrary principles]].
- +
-See section [[#contrary principles]] for further aspects.+
  
  
Line 106: Line 104:
 } }
  
-private ResultDto toDto(ResultEntity) {+private ResultDto toDto(ResultEntity entity) {
     ResultDto dto = new ResultDto();     ResultDto dto = new ResultDto();
     dto.setShoeSize(entity.getShoeSize());             dto.setShoeSize(entity.getShoeSize());        
Line 121: Line 119:
 ==== Example3: Parameter Checking ==== ==== Example3: Parameter Checking ====
  
-==== Example4: Algorithms ==== +==== Example4: Extracting Classes ====
- +
-==== Example5: Extracting Classes ====+
  
 ===== Description Status ===== ===== Description Status =====
Line 139: Line 135:
  
 Discuss this wiki article and the principle on the corresponding [[talk:principles:Single Level of Abstraction|talk page]]. Discuss this wiki article and the principle on the corresponding [[talk:principles:Single Level of Abstraction|talk page]].
 +
principles/single_level_of_abstraction.txt · Last modified: 2021-10-18 22:03 by christian