While cleaning up some legacy code, I found a method designed to verify that a formatted string contained a valid time. The expected format was “hh:mm:ss xx”, where ‘hh’ represents the hour, ‘mm’ represents minutes, ‘ss’ represents seconds, and ‘xx’ is either ‘AM’ or ‘PM’. It seemed fairly long so I took a closer look.

+

You've been focused for hours on some gnarly problem and there's no solution in sight. So you get up to stretch your legs, or to hit the vending machines, and on the way back the answer suddenly becomes obvious.

+

+

Does this scenario sound familiar? Ever wonder why it happens? The trick is that while you're coding, the logical part of your brain is active and the creative side is shut out. It can't present anything to you until the logical side takes a break.

+

+

Here's a real-life example: I was cleaning up some legacy code and ran into an 'interesting' method. It was designed to verify that a string contained a valid time using the format ''hh:mm:ss xx'', where ''hh'' represents the hour, ''mm'' represents minutes, ''ss'' represents seconds, and ''xx'' is either ''AM'' or ''PM''.

+

+

The method used the following code to convert two characters (representing the hour) into a number, and verify it was within the proper range:

-

The method used the following code to convert two characters (representing the hour) into a number, and verify that it was within the proper range:

try {

try {

-

Integer.parseInt( time.substring(0, 2) );

+

Integer.parseInt(time.substring(0, 2));

-

} catch ( Exception x ) {

+

} catch (Exception x) {

return false;

return false;

}

}

-

if ( Integer.parseInt(time.substring(0, 2) ) > 12) {

+

if (Integer.parseInt(time.substring(0, 2)) > 12) {

return false;

return false;

}

}

-

The same basic code appeared twice more, with appropriate changes to the character offset and upper limit, to test the minutes and seconds. The method ended with these lines to test for ‘AM’ or ‘PM’:

+

The same code appeared twice more, with appropriate changes to the character offset and upper limit, to test the minutes and seconds. The method ended with these lines to check for ''AM'' and ''PM'':

If none of the previous code found a problem and returned “false” then the method returned “true”.

+

If none of this series of comparisons failed, returning <code>false</code>, the method returned <code>true</code>.

-

If the preceding code seems wordy and difficult to follow, don’t worry. Even an experienced Java developer might think the same; which meant I’d found something worth cleaning up. I refactored it and wrote a few unit tests - just to make sure it still worked.

+

If the preceding code seems wordy and difficult to follow, don't worry. I thought so too &mdash; which meant I'd found something worth cleaning up. I refactored it and wrote a few unit tests, just to make sure it still worked.

-

I felt pleased with the rsults. The new version was easier to read, half the size, and more accurate because the original code had only tested the upper bounds for the hour, minutes, and seconds. Not bad for half an hour’s work.

+

When I finished, I felt pleased with the results. The new version was easy to read, half the size, and more accurate because the original code tested only the upper boundary for the hours, minutes, and seconds.

-

While getting ready for work the next day, an idea popped in my head; use a regular expression to validate the string. After a few minutes typing, I had a new implementation that only needed one line of code. It worked, but it felt too complicated so I split it in two to make it more readable. Here it is:

+

While getting ready for work the next day, an idea popped in my head: Why not validate the string using a regular expression? After a few minutes typing, I had a working implementation in just one line of code. Here it is:

The point of this story is not that I eventually wrote two lines of code that did what the original didn’t quite accomplish with over thirty. The point is that until I got away from the computer, I thought my first attempt was the best solution to the problem.

+

public static boolean validateTime(String time) {

+

return time.matches("(0[1-9]|1[0-2]):[0-5][0-9]:[0-5][0-9] ([AP]M)");

+

}

-

If you’re an experienced programmer, you’ve probably had similar experiences. It often goes like this: You’ve been focused for hours on some gnarly problem and there's no solution in sight. You get up for a bio-break, or to hit the vending machines, and on the way back the answer suddenly becomes obvious.

+

The point of this story is not that I eventually replaced over thirty lines of code with just one. The point is that until I got away from the computer, I thought my first attempt was the best solution to the problem.

-

The trick is that while you’re coding, the logical part of your brain is active and the creative side is shut out. It can’t present anything to you until the logical side takes a break. So put the mouse down and step away from the keyboard. The insights you gain may surprise you.

+

So the next time you hit a nasty problem, do yourself a favor. Once you really understand the problem go do something involving the creative side of your brain &mdash; sketch out the problem, listen to some music, or just take a walk outside. Sometimes the best thing you can do to solve a problem is to put the mouse down and step away from the keyboard.

By [[BurkHufnagel]]

By [[BurkHufnagel]]

Current revision

You've been focused for hours on some gnarly problem and there's no solution in sight. So you get up to stretch your legs, or to hit the vending machines, and on the way back the answer suddenly becomes obvious.

Does this scenario sound familiar? Ever wonder why it happens? The trick is that while you're coding, the logical part of your brain is active and the creative side is shut out. It can't present anything to you until the logical side takes a break.

Here's a real-life example: I was cleaning up some legacy code and ran into an 'interesting' method. It was designed to verify that a string contained a valid time using the format hh:mm:ss xx, where hh represents the hour, mm represents minutes, ss represents seconds, and xx is either AM or PM.

The method used the following code to convert two characters (representing the hour) into a number, and verify it was within the proper range:

If none of this series of comparisons failed, returning false, the method returned true.

If the preceding code seems wordy and difficult to follow, don't worry. I thought so too — which meant I'd found something worth cleaning up. I refactored it and wrote a few unit tests, just to make sure it still worked.

When I finished, I felt pleased with the results. The new version was easy to read, half the size, and more accurate because the original code tested only the upper boundary for the hours, minutes, and seconds.

While getting ready for work the next day, an idea popped in my head: Why not validate the string using a regular expression? After a few minutes typing, I had a working implementation in just one line of code. Here it is:

The point of this story is not that I eventually replaced over thirty lines of code with just one. The point is that until I got away from the computer, I thought my first attempt was the best solution to the problem.

So the next time you hit a nasty problem, do yourself a favor. Once you really understand the problem go do something involving the creative side of your brain — sketch out the problem, listen to some music, or just take a walk outside. Sometimes the best thing you can do to solve a problem is to put the mouse down and step away from the keyboard.