1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
/*******************************************************************************
* Copyright (c) 2001, 2005 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
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* IBM Corporation - initial API and implementation
* Jens Lukowski/Innoopract - initial renaming/restructuring
*
*******************************************************************************/
package org.eclipse.wst.sse.core.internal.cleanup;
import java.io.IOException;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.wst.sse.core.internal.provisional.IStructuredModel;
import org.w3c.dom.Node;
/**
* This interface and related classes are 'internal' and should not
* be treated as API, even though used across components in WTP.
* Consider it a work in progress.
*/
public interface IStructuredCleanupProcessor {
/**
* This form of the CleanupProcessor takes an input string as input,
* creates an InputStream from the input string, create a temporary model
* of the content type specified, cleanups the whole model, then returns
* the cleaned up input string.
*/
String cleanupContent(String content) throws IOException, CoreException;
/**
* This form of the CleanupProcessor takes an input string as input,
* creates an InputStream from the input string, create a temporary model
* of the content type specified, cleanups the model within start and
* length, then returns the cleaned up input string.
*/
String cleanupContent(String content, int start, int length) throws IOException, CoreException;
/**
* This form of the CleanupProcessor takes an IDocument as input, creates
* a temporary model of content type calculated using the IDocument's file
* extension, cleanups the whole model, then releases the model.
*/
void cleanupDocument(IDocument document) throws IOException, CoreException;
/**
* This form of the CleanupProcessor takes an IDocument as input, creates
* a temporary model of content type calculated using the IDocument's file
* extension, cleanups the model within start and length, then releases
* the model.
*/
void cleanupDocument(IDocument document, int start, int length) throws IOException, CoreException;
/**
* This form of the CleanupProcessor takes an IFile as input, creates a
* temporary model of content type calculated using the IFile's file
* extension, cleanups the whole model, then releases the model. The IFile
* is updated when the last reference of the model is released in the
* model manager.
*/
void cleanupFile(IFile file) throws IOException, CoreException;
/**
* This form of the CleanupProcessor takes an IFile as input, creates a
* temporary model of content type calculated using the IFile's file
* extension, cleanups the model within start and length, then releases
* the model. The IFile is updated when the last reference of the model is
* released in the model manager.
*/
void cleanupFile(IFile file, int start, int length) throws IOException, CoreException;
/**
* This form of the CleanupProcessor takes a file name as input,creates an
* InputStream from the file, create a temporary model of content type
* calculated using the file name's file extension, cleanups the whole
* model, then releases the model. The file is updated when the last
* reference of the model is released in the model manager.
*/
void cleanupFileName(String fileName) throws IOException, CoreException;
/**
* This form of the CleanupProcessor takes a file name as input,creates an
* InputStream from the file, create a temporary model of content type
* calculated using the file name's file extension, cleanups the model
* within start and length, then releases the model. The file is updated
* when the last reference of the model is released in the model manager.
*/
void cleanupFileName(String fileName, int start, int length) throws IOException, CoreException;
/**
* This form of the CleanupProcessor takes a model as input, and cleanups
* the whole model.
*/
void cleanupModel(IStructuredModel structuredModel);
/**
* This form of the CleanupProcessor takes a model as input, and cleanups
* the model within start and length.
*/
void cleanupModel(IStructuredModel structuredModel, int start, int length);
/**
* This form of the CleanupProcessor takes a node as input, and formats
* the node and all its children.
*/
void cleanupNode(Node node);
}
|
