Eclipse Plug-in Developer Guide (Galileo) - WorkspacePatcherUI (Eclipse Platform API Specification)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Eclipse Platform
Release 3.5

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.compare.patch
Class WorkspacePatcherUI


java.lang.Object
  
org.eclipse.compare.patch.WorkspacePatcherUI

public class WorkspacePatcherUI
extends Object
extends Object

Provides the headers required to create a workspace patch.

Since:: 3.2
Restriction:: This class is not intended to be subclassed by clients.
Restriction:: This class is not intended to be instantiated by clients.

Constructor Summary

WorkspacePatcherUI ()


Method Summary

static String getWorkspacePatchHeader ()
          Returns a string that must be the first line of a workspace patch (a multi-project patch that is understood by the Apply Patch wizard).

static String getWorkspacePatchProjectHeader ( IProject project)
          Returns the project header that must appear before any patches that apply to that project.

Methods inherited from class java.lang. Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WorkspacePatcherUI

public WorkspacePatcherUI()

Method Detail

getWorkspacePatchHeader

public static 
String getWorkspacePatchHeader()

Returns a string that must be the first line of a workspace patch (a multi-project patch that is understood by the Apply Patch wizard). Each project to be included in the patch must be prefixed by the line obtained from the getWorkspacePatchProjectHeader(). This snippet outlines how the a workspace patch is to be created:

  //Write out workspace patch header
  stream.println(CompareUI.getWorkspacePatchHeader());
  for (int i=0; i





Returns:
String

Since:

  3.2

See Also:


getWorkspacePatchProjectHeader(IProject)

getWorkspacePatchProjectHeader

public static 
String getWorkspacePatchProjectHeader(
IProject project)

Returns the project header that must appear before any patches that apply to that project. All patches that are encountered after this header and before the next header are understood to belong the the project.