1 /* 2 * Copyright (C) 2010 Google Inc. 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 com.google.clearsilver.jsilver.data; 18 19 /** 20 * Encapsulates the {@code WeakInterningPool<String>} functionality with added optimizations. To be 21 * used to optimize the memory usage and garbage collection during text processing. 22 */ 23 public interface StringInternStrategy { 24 /** 25 * Interns a String object in a pool and returns a String equal to the one provided. 26 * 27 * <p> 28 * If there exists a String in the pool equal to the provided value then it will be returned. 29 * Otherwise provided String <b>may</b> be interned. 30 * 31 * <p> 32 * There is no guarantees on when the pool will return the same object as provided. It is possible 33 * that value == intern(value) will never be true. 34 * 35 * @param value String to be interned 36 * @return a String that is equal to the one provided. 37 */ intern(String value)38 String intern(String value); 39 } 40