org.eclipse.core.resources.IEncodedStorage Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aspectjtools Show documentation

AspectJ tools most notably contains the AspectJ compiler (AJC). AJC applies aspects to Java classes during compilation, fully replacing Javac for plain Java classes and also compiling native AspectJ or annotation-based @AspectJ syntax. Furthermore, AJC can weave aspects into existing class files in a post-compile binary weaving step. This library is a superset of AspectJ weaver and hence also of AspectJ runtime.

There is a newer version: 1.9.22.1

Show newest version

/*******************************************************************************
 *  Copyright (c) 2004, 2009 IBM Corporation and others.
 *
 *  This program and the accompanying materials
 *  are made available under the terms of the Eclipse Public License 2.0
 *  which accompanies this distribution, and is available at
 *  https://www.eclipse.org/legal/epl-2.0/
 *
 *  SPDX-License-Identifier: EPL-2.0
 *
 *  Contributors:
 *     IBM Corporation - initial API and implementation
 *******************************************************************************/
package org.eclipse.core.resources;

import org.eclipse.core.runtime.CoreException;

/**
 * A storage that knows how its contents are encoded.
 *
 * The IEncodedStorage interface extends IStorage
 * in order to provide access to the charset to be used when decoding its
 * contents.
 * 

 * Clients may implement this interface.
 * 
 *
 * @since 3.0
 */
public interface IEncodedStorage extends IStorage {
	/**
	 * Returns the name of a charset encoding to be used when decoding this
	 * storage's contents into characters. Returns null if a proper
	 * encoding cannot be determined.
	 * 
	 * Note that this method does not check whether the result is a supported
	 * charset name. Callers should be prepared to handle
	 * UnsupportedEncodingException where this charset is used.
	 * 
	 *
	 * @return the name of a charset, or null
	 * @exception CoreException if an error happens while determining
	 * the charset. See any refinements for more information.
	 * @see IStorage#getContents()
	 */
	String getCharset() throws CoreException;
}