/NRefactory/ICSharpCode.NRefactory.CSharp/Refactoring/Action.cs

 1// 
 2// Change.cs
 3//  
 4// Author:
 5//       Mike Kr?ger <mkrueger@novell.com>
 6// 
 7// Copyright (c) 2011 Mike Kr?ger <mkrueger@novell.com>
 8// 
 9// Permission is hereby granted, free of charge, to any person obtaining a copy
10// of this software and associated documentation files (the "Software"), to deal
11// in the Software without restriction, including without limitation the rights
12// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13// copies of the Software, and to permit persons to whom the Software is
14// furnished to do so, subject to the following conditions:
15// 
16// The above copyright notice and this permission notice shall be included in
17// all copies or substantial portions of the Software.
18// 
19// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25// THE SOFTWARE.
26using System;
27
28namespace ICSharpCode.NRefactory.CSharp.Refactoring
29{
30	/// <summary>
31	/// This is the base class for all refactoring operations that are performed.
32	/// </summary>
33	public abstract class Action
34	{
35		/// <summary>
36		/// Gets or sets the description.
37		/// </summary>
38		/// <value>
39		/// A brief description of the refactoring change.
40		/// </value>
41		public string Description {
42			get;
43			set;
44		}
45		
46		/// <summary>
47		/// Performs the change.
48		/// </summary>
49		/// <param name='rctx'>
50		/// The context on which the change should perform on.
51		/// </param>
52		public abstract void Perform (Script script);
53	}
54}
55