opennlp.tools.util.jvm.StringInterner Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package opennlp.tools.util.jvm;
/**
* A marker-interface for a String interner implementation.
*/
public interface StringInterner {
/**
* Interns and returns a reference to the representative instance
* for any collection of string instances that are equal to each other.
*
* @param sample string instance to be interned
* @return reference to the interned string instance
*/
String intern(String sample);
}