1 /* 2 * ModeShape (http://www.modeshape.org) 3 * See the COPYRIGHT.txt file distributed with this work for information 4 * regarding copyright ownership. Some portions may be licensed 5 * to Red Hat, Inc. under one or more contributor license agreements. 6 * See the AUTHORS.txt file in the distribution for a full listing of 7 * individual contributors. 8 * 9 * ModeShape is free software. Unless otherwise indicated, all code in ModeShape 10 * is licensed to you under the terms of the GNU Lesser General Public License as 11 * published by the Free Software Foundation; either version 2.1 of 12 * the License, or (at your option) any later version. 13 * 14 * ModeShape is distributed in the hope that it will be useful, 15 * but WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 * Lesser General Public License for more details. 18 * 19 * You should have received a copy of the GNU Lesser General Public 20 * License along with this software; if not, write to the Free 21 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 22 * 02110-1301 USA, or see the FSF site: http://www.fsf.org. 23 */ 24 package org.modeshape.common.text; 25 26 import net.jcip.annotations.Immutable; 27 28 /** 29 * Interface for components that can decode text. This is the counterpart to {@link TextEncoder}. 30 * 31 * @see TextEncoder 32 */ 33 @Immutable 34 public interface TextDecoder { 35 36 /** 37 * Return the decoded version of an encoded string 38 * 39 * @param encodedText the encoded text 40 * @return the unecoded form of the text, or null if the supplied node name is also null 41 * @see TextEncoder#encode(String) 42 */ 43 public String decode( String encodedText ); 44 45 }