/*******************************************************************************
* Copyright (c) 2000, 2011 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.compare;
import org.eclipse.core.runtime.CoreException;
/**
* Extension for IStreamContentAccessor
. Extends the original
* concept of a IStreamContentAccessor
to answer the Charset (encoding) used for the stream.
*
* @since 3.0
*/
public interface IEncodedStreamContentAccessor extends IStreamContentAccessor {
/**
* Returns the name of a charset encoding to be used when decoding this
* stream accessor's contents into characters. Returns null
if a proper
* encoding cannot be determined.
*
* Note: 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.
*
null
* @exception CoreException if an error happens while determining
* the charset. See any refinements for more information.
* @see IStreamContentAccessor#getContents
* @since 3.0
*/
String getCharset() throws CoreException;
}