001//////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code for adherence to a set of rules. 003// Copyright (C) 2001-2014 Oliver Burn 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018//////////////////////////////////////////////////////////////////////////////// 019package com.puppycrawl.tools.checkstyle.api; 020 021import java.util.EventObject; 022 023 024/** 025 * Raw event for audit. 026 * <p> 027 * <i> 028 * I'm not very satisfied about the design of this event since there are 029 * optional methods that will return null in most of the case. This will 030 * need some work to clean it up especially if we want to introduce 031 * a more sequential reporting action rather than a packet error 032 * reporting. This will allow for example to follow the process quickly 033 * in an interface or a servlet (yep, that's cool to run a check via 034 * a web interface in a source repository ;-) 035 * </i> 036 * </p> 037 * 038 * @author <a href="mailto:stephane.bailliez@wanadoo.fr">Stephane Bailliez</a> 039 * @see AuditListener 040 */ 041public final class AuditEvent 042 extends EventObject 043{ 044 /** Record a version. */ 045 private static final long serialVersionUID = -3774725606973812736L; 046 /** filename event associated with **/ 047 private final String fileName; 048 /** message associated with the event **/ 049 private final transient LocalizedMessage message; 050 051 /** 052 * Creates a new instance. 053 * @param source the object that created the event 054 */ 055 public AuditEvent(Object source) 056 { 057 this(source, null); 058 } 059 060 /** 061 * Creates a new <code>AuditEvent</code> instance. 062 * @param src source of the event 063 * @param fileName file associated with the event 064 */ 065 public AuditEvent(Object src, String fileName) 066 { 067 this(src, fileName, null); 068 } 069 070 /** 071 * Creates a new <code>AuditEvent</code> instance. 072 * 073 * @param src source of the event 074 * @param fileName file associated with the event 075 * @param message the actual message 076 */ 077 public AuditEvent(Object src, String fileName, LocalizedMessage message) 078 { 079 super(src); 080 this.fileName = fileName; 081 this.message = message; 082 } 083 084 /** 085 * @return the file name currently being audited or null if there is 086 * no relation to a file. 087 */ 088 public String getFileName() 089 { 090 return fileName; 091 } 092 093 /** 094 * return the line number on the source file where the event occurred. 095 * This may be 0 if there is no relation to a file content. 096 * @return an integer representing the line number in the file source code. 097 */ 098 public int getLine() 099 { 100 return message.getLineNo(); 101 } 102 103 /** 104 * return the message associated to the event. 105 * @return the event message 106 */ 107 public String getMessage() 108 { 109 return message.getMessage(); 110 } 111 112 /** @return the column associated with the message **/ 113 public int getColumn() 114 { 115 return message.getColumnNo(); 116 } 117 118 /** @return the audit event severity level **/ 119 public SeverityLevel getSeverityLevel() 120 { 121 return (message == null) 122 ? SeverityLevel.INFO 123 : message.getSeverityLevel(); 124 } 125 126 /** 127 * @return the identifier of the module that generated the event. Can return 128 * null. 129 */ 130 public String getModuleId() 131 { 132 return message.getModuleId(); 133 } 134 135 /** @return the name of the source for the message **/ 136 public String getSourceName() 137 { 138 return message.getSourceName(); 139 } 140 141 /** @return the localized message **/ 142 public LocalizedMessage getLocalizedMessage() 143 { 144 return message; 145 } 146}