View Javadoc

1   /*
2    * Entagged Audio Tag library
3    * Copyright (c) 2003-2005 Raphaël Slinckx <raphael@slinckx.net>
4    * 
5    * This library is free software; you can redistribute it and/or
6    * modify it under the terms of the GNU Lesser General Public
7    * License as published by the Free Software Foundation; either
8    * version 2.1 of the License, or (at your option) any later version.
9    *  
10   * This library is distributed in the hope that it will be useful,
11   * but WITHOUT ANY WARRANTY; without even the implied warranty of
12   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13   * Lesser General Public License for more details.
14   * 
15   * You should have received a copy of the GNU Lesser General Public
16   * License along with this library; if not, write to the Free Software
17   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18   */
19  package entagged.audioformats.generic;
20  
21  /***
22   * This interface extends the default field definition by methods for working
23   * with human readable text.<br>
24   * A TagTextField does not store binary data.
25   * 
26   * @author Raphaël Slinckx
27   */
28  public interface TagTextField extends TagField {
29  
30  	/***
31  	 * Returns the content of the field.
32  	 * 
33  	 * @return Content
34  	 */
35  	public String getContent();
36  
37  	/***
38  	 * Returns the current used charset encoding.
39  	 * 
40  	 * @return Charset encoding.
41  	 */
42  	public String getEncoding();
43  
44  	/***
45  	 * Sets the content of the field.
46  	 * 
47  	 * @param content
48  	 *            fields content.
49  	 */
50  	public void setContent(String content);
51  
52  	/***
53  	 * Sets the charset encoding used by the field.
54  	 * 
55  	 * @param encoding
56  	 *            charset.
57  	 */
58  	public void setEncoding(String encoding);
59  }