View Javadoc

1   /*
2    * Copyright 2004-2009 the original author or authors.
3    *
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.springmodules.validation.util.condition.string;
18  
19  import org.springmodules.validation.util.condition.Condition;
20  import org.springmodules.validation.util.condition.NonNullAcceptingTypeSpecificCondition;
21  
22  /**
23   * An abstract condition that can be applied on objects of type {@link java.lang.String}.
24   *
25   * @author Uri Boness
26   */
27  public abstract class AbstractStringCondition extends NonNullAcceptingTypeSpecificCondition {
28  
29      protected final static String EMPTY_STRING = "";
30  
31      /**
32       * Constructs a new AbstractStringCondition.
33       */
34      protected AbstractStringCondition() {
35          super(String.class);
36      }
37  
38      /**
39       * See {@link Condition#check(Object)}
40       *
41       * @throws IllegalArgumentException if the given object is either <code>null</code> or not of a
42       * <code>java.lang.String</code> type.
43       */
44      public final boolean doCheck(Object object) {
45          return checkString((String) object);
46      }
47  
48      /**
49       * Checks whether the given string adheres to this condition.
50       *
51       * @param text The string to be checked.
52       * @return <code>true</code> if the given string adheres to this condition, <code>false</code> otherwise.
53       */
54      protected abstract boolean checkString(String text);
55  
56  }