ULSAC
Anti-Pattern Name:
ULSAC Anti Pattern
Aliases:
Failed Façade Command Pattern Problem
Context
By trying to make a API method more generalized- you make it too generalized
Forces
- Trying to prevent code change
- Failing to program to interface, in the sense if the implemented class changes it should signal failures else where in the code base.
Solution
Create well defined methods (and names) that explain the exact nature of the method.
Consequences and Resulting Context
- The complexity of the call gets embedded with in a parameter.
- API can’t be readily understood.
- Functionally Overloaded method
- Hard to change.
- Difficult API to use.
What's Wrong with the Solution
Consider the following API which contains self describing methods that can be readily understood and used.
void getCustomerNumber(…);
void getCustomerAddress(…);
void getCustomerTelephone(…);
If a scenario arises in which a developer tries to prevent the API exposed to change by creating an overly generalized method
void getX(…., String actionDesc)
in which the actionDesc contains some sort of internal pseudo language which determines the correct data to return. i.e.
call getCustomerNumber(…) gets replaced with call getX(….,”CustomerNumber”);
call getCustomerNumber(…)+ call getCustomerAddress(…) gets replaced with call getX(….,”CustomerNumber,CustomerAddress”);
Lesson's Learned
Try not to make a single method be all things to everyone. Rely on programming to interface and contractible programming it allows.
Correct Patterns
Author(s):
John Wilson
Date:
01/01/2009
References
Keywords:
Example
ULSAC Anti Pattern
Aliases:
Failed Façade Command Pattern Problem
Context
By trying to make a API method more generalized- you make it too generalized
Forces
- Trying to prevent code change
- Failing to program to interface, in the sense if the implemented class changes it should signal failures else where in the code base.
Solution
Create well defined methods (and names) that explain the exact nature of the method.
Consequences and Resulting Context
- The complexity of the call gets embedded with in a parameter.
- API can’t be readily understood.
- Functionally Overloaded method
- Hard to change.
- Difficult API to use.
What's Wrong with the Solution
Consider the following API which contains self describing methods that can be readily understood and used.
void getCustomerNumber(…);
void getCustomerAddress(…);
void getCustomerTelephone(…);
If a scenario arises in which a developer tries to prevent the API exposed to change by creating an overly generalized method
void getX(…., String actionDesc)
in which the actionDesc contains some sort of internal pseudo language which determines the correct data to return. i.e.
call getCustomerNumber(…) gets replaced with call getX(….,”CustomerNumber”);
call getCustomerNumber(…)+ call getCustomerAddress(…) gets replaced with call getX(….,”CustomerNumber,CustomerAddress”);
Lesson's Learned
Try not to make a single method be all things to everyone. Rely on programming to interface and contractible programming it allows.
Correct Patterns
Author(s):
John Wilson
Date:
01/01/2009
References
Keywords:
Example
Get the ULSAC mug.