KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > ltk > core > refactoring > ContentStamp


1 /*******************************************************************************
2  * Copyright (c) 2000, 2005 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials
4  * are made available under the terms of the Eclipse Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/epl-v10.html
7  *
8  * Contributors:
9  * IBM Corporation - initial API and implementation
10  *******************************************************************************/
11 package org.eclipse.ltk.core.refactoring;
12
13 /**
14  * A content stamp object represent the content of an <code>IFile</code>.
15  * A content stamp object is updated whenever the content of a file
16  * changes. In contrast to a time stamp a content stamp is reverted
17  * to its previous value if the content of the file is reverted back by
18  * performing a corresponding undo change.
19  * <p>
20  * Clients of the refactoring framework don't need to take care of content
21  * stamps. They are managed by the framework itself.
22  * </p>
23  * <p>
24  * In version 3.0 not all files in the workspace are annotated with a content stamp. The
25  * refactoring framework only adds content stamp to those files where necessary. As of
26  * version 3.1 the content stamps are mapped to the resource's modification stamp.
27  * </p>
28  * <p>
29  * Content stamp are to be compared using the <code>equals(Object)</code> method.
30  * It is not guaranteed that content stamps are identical for identical files.
31  * </p>
32  * <p>
33  * This class is not intended to be extended by clients.
34  * </p>
35  *
36  * @since 3.0
37  */
38 public abstract class ContentStamp {
39
40     /**
41      * Checks whether the stamp is the null stamp or not. A null stamp
42      * is generated for files which either don't exist or exist in a
43      * closed project.
44      *
45      * @return whether the stamp is the null stamp or not.
46      */
47     public abstract boolean isNullStamp();
48 }
49
Popular Tags