View Javadoc
1 /* ==================================================================== 2 * The Apache Software License, Version 1.1 3 * 4 * Copyright (c) 2000 The Apache Software Foundation. All rights 5 * reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in 16 * the documentation and/or other materials provided with the 17 * distribution. 18 * 19 * 3. The end-user documentation included with the redistribution, 20 * if any, must include the following acknowledgment: 21 * "This product includes software developed by the 22 * Apache Software Foundation (http://www.apache.org/)." 23 * Alternately, this acknowledgment may appear in the software itself, 24 * if and wherever such third-party acknowledgments normally appear. 25 * 26 * 4. The names "Apache" and "Apache Software Foundation" must 27 * not be used to endorse or promote products derived from this 28 * software without prior written permission. For written 29 * permission, please contact apache@apache.org. 30 * 31 * 5. Products derived from this software may not be called "Apache", 32 * nor may "Apache" appear in their name, without prior written 33 * permission of the Apache Software Foundation. 34 * 35 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 36 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 37 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 38 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 39 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 40 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 41 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 42 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 43 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 44 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 45 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 46 * SUCH DAMAGE. 47 * ==================================================================== 48 * 49 * This software consists of voluntary contributions made by many 50 * individuals on behalf of the Apache Software Foundation. For more 51 * information on the Apache Software Foundation, please see 52 * <http://www.apache.org/>. 53 * 54 * Portions of this software are based upon public domain software 55 * originally written at the National Center for Supercomputing Applications, 56 * University of Illinois, Urbana-Champaign. 57 */ 58 package com.bonevich.eclipse.logging.popups; 59 60 import com.bonevich.eclipse.logging.LoggingPlugin; 61 import com.bonevich.eclipse.logging.LoggingPluginMessages; 62 import com.bonevich.eclipse.logging.LoggingPluginResources; 63 64 import org.eclipse.jdt.core.ICompilationUnit; 65 import org.eclipse.jdt.ui.IWorkingCopyManager; 66 import org.eclipse.jdt.ui.JavaUI; 67 import org.eclipse.jface.action.IAction; 68 import org.eclipse.jface.dialogs.MessageDialog; 69 import org.eclipse.jface.dialogs.ProgressMonitorDialog; 70 import org.eclipse.jface.viewers.ISelection; 71 import org.eclipse.ui.*; 72 import org.eclipse.ui.texteditor.ITextEditor; 73 74 import java.lang.reflect.InvocationTargetException; 75 76 /*** 77 * Base class for actions that add logging statements to the current JavaEditor. 78 * 79 * @author jbonevic 80 */ 81 public abstract class AddLoggingAction 82 implements IEditorActionDelegate, LoggingPluginResources 83 { 84 private ITextEditor _editor; 85 86 /*** 87 * @see IObjectActionDelegate#setActivePart(IAction, IWorkbenchPart) 88 */ 89 public void setActiveEditor(IAction action, IEditorPart part) 90 { 91 if (part instanceof ITextEditor) 92 { 93 _editor = (ITextEditor) part; 94 } 95 } 96 97 /*** 98 * @see IActionDelegate#selectionChanged(IAction, ISelection) 99 */ 100 public void selectionChanged(IAction action, ISelection selection) 101 { 102 IWorkbenchWindow window = PlatformUI.getWorkbench().getActiveWorkbenchWindow(); 103 if (window != null) 104 { 105 IWorkbenchPage page = window.getActivePage(); 106 if (page != null) 107 { 108 IEditorPart editor = page.getActiveEditor(); 109 if (editor != null && editor instanceof ITextEditor) 110 { 111 setActiveEditor(action, editor); 112 } 113 } 114 } 115 } 116 117 /*** 118 * @see IEditorActionDelegate#run(IAction) 119 */ 120 public void run(IAction action) 121 { 122 IWorkingCopyManager manager = JavaUI.getWorkingCopyManager(); 123 ICompilationUnit unit = manager.getWorkingCopy(_editor.getEditorInput()); 124 boolean saveWork = LoggingPlugin.getPlugin().getAutoSavePreference(); 125 126 if (unit != null) 127 { 128 AddLoggingOperation op = 129 new AddLoggingOperation( 130 _editor, unit, this, saveWork 131 ); 132 133 try 134 { 135 ProgressMonitorDialog dialog = new ProgressMonitorDialog(_editor.getSite().getShell()); 136 dialog.run(false, true, op); 137 } 138 catch (InvocationTargetException e) 139 { 140 e.printStackTrace(); 141 MessageDialog.openError( 142 PlatformUI.getWorkbench().getActiveWorkbenchWindow().getShell(), 143 LoggingPluginMessages.bind(ADD_LOGGING_ERROR), 144 e.getTargetException().getMessage() 145 ); 146 } 147 catch (InterruptedException ignored) 148 { 149 } 150 } 151 } 152 153 /*** 154 * Retrieve an implementation-specific logging statement to be 155 * inserted into code. Tied to logging-levels, so each action 156 * provides its own. 157 * @return loggingStatement 158 */ 159 protected abstract String getLoggingStatement(String impl); 160 161 /*** 162 * Retrieve an implementation-specific logging statement 163 * wrapped in a conditional log-level check to be inserted 164 * into code. Tied to logging-levels, so each action provides 165 * its own. 166 * @return loggingStatement 167 */ 168 protected abstract String getConditionalLoggingStatement(String impl); 169 170 /*** 171 * Indicate whether to use a conditional-wrapped logging statement. 172 * @return conditionalUsed 173 */ 174 protected abstract boolean isConditionalUsed(); 175 176 } 177

This page was automatically generated by Maven