[nobug] doc
diff --git a/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/document/IDocumentLoader.java b/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/document/IDocumentLoader.java index 20a99d6..b7eff1e 100644 --- a/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/document/IDocumentLoader.java +++ b/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/document/IDocumentLoader.java
@@ -23,8 +23,15 @@ import org.eclipse.wst.sse.core.internal.provisional.document.IEncodedDocument; +/** + * Provides methods for the creation of an IStructuredDocument correctly + * prepared to work with a particular type of content. + */ public interface IDocumentLoader { + /** + * @return a new IStructuredDocument prepared by this loader + */ IEncodedDocument createNewStructuredDocument(); /** @@ -50,12 +57,15 @@ IEncodedDocument createNewStructuredDocument(String filename, InputStream istream, EncodingRule encodingRule) throws java.io.IOException; + /** + * @return the document partitioner + */ IDocumentPartitioner getDefaultDocumentPartitioner(); IDocumentCharsetDetector getDocumentEncodingDetector(); /** - * A utility method, but depends on subclasses to impliment the preferred + * A utility method, but depends on subclasses to implement the preferred * end of line for a particular content type. Note: subclasses should not * re-implement this method (there's no reason to, even though its part of * interface). This method not only converts end-of-line characters, if @@ -63,6 +73,8 @@ * structuredDocument. The returned value is either the original string, * if no conversion is needed, or a new string with end-of-lines * converted. + * + * @deprecated - the content's line delimiters should be preserved */ StringBuffer handleLineDelimiter(StringBuffer originalString, IEncodedDocument theStructuredDocument);
diff --git a/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/ltk/modelhandler/IDocumentTypeHandler.java b/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/ltk/modelhandler/IDocumentTypeHandler.java index d4862a4..aa62963 100644 --- a/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/ltk/modelhandler/IDocumentTypeHandler.java +++ b/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/ltk/modelhandler/IDocumentTypeHandler.java
@@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2001, 2005 IBM Corporation and others. + * Copyright (c) 2001, 2009 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -16,8 +16,8 @@ import org.eclipse.wst.sse.core.internal.document.IDocumentLoader; /** - * Interface to allow custom content types to be defined as extension points - * in plugins. + * Responsible for providing the mechanisms used in the correct loading of an + * IStructuredDocument's contents and determine its self-described encoding. */ public interface IDocumentTypeHandler {
diff --git a/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/ltk/modelhandler/IModelHandler.java b/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/ltk/modelhandler/IModelHandler.java index c2947d4..588f39e 100644 --- a/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/ltk/modelhandler/IModelHandler.java +++ b/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/ltk/modelhandler/IModelHandler.java
@@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2001, 2005 IBM Corporation and others. + * Copyright (c) 2001, 2009 IBM Corporation and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -17,6 +17,10 @@ import org.eclipse.wst.sse.core.internal.provisional.IModelLoader; +/** + * Responsible for providing the mechanisms used in the correct loading of an + * IStructuredModel's contents and initialization of its adapter factories. + */ public interface IModelHandler extends IDocumentTypeHandler { /** * This method should return Factories which are added automatically by
diff --git a/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/provisional/IStructuredModel.java b/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/provisional/IStructuredModel.java index 568d5dd..5d67830 100644 --- a/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/provisional/IStructuredModel.java +++ b/bundles/org.eclipse.wst.sse.core/src/org/eclipse/wst/sse/core/internal/provisional/IStructuredModel.java
@@ -119,16 +119,25 @@ /** * @deprecated + * @see IModelManager#copyModelForEdit(String, String) */ IStructuredModel copy(String id) throws ResourceInUse, ResourceAlreadyExists; /** * Disable undo management. + * + * @deprecated - the ability to enable and disable Undo management for the + * model cannot be guaranteed as it implicitly requires + * knowledge of the underlying undo/redo implementation */ void disableUndoManagement(); /** * Enable undo management. + * + * @deprecated - the ability to enable and disable Undo management for the + * model cannot be guaranteed as it implicitly requires + * knowledge of the underlying undo/redo implementation */ void enableUndoManagement(); @@ -152,6 +161,10 @@ /** * @return The associated content type identifier (String) for this model. + * This value may be more accurate than the content type against + * which the model handler was registered. + * + * @see IModelHandler#getAssociatedContentTypeId() */ String getContentTypeIdentifier(); @@ -174,6 +187,9 @@ */ IndexedRegion getIndexedRegion(int offset); + /** + * @return the model's handler + */ IModelHandler getModelHandler(); IModelManager getModelManager();