001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2022 the original author or authors.
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////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.api;
021
022import java.util.EventObject;
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
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 * @see AuditListener
039 * @noinspection SerializableHasSerializationMethods
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    /** Violation associated with the event. **/
049    private final Violation violation;
050
051    /**
052     * Creates a new instance.
053     *
054     * @param source the object that created the event
055     */
056    public AuditEvent(Object source) {
057        this(source, null);
058    }
059
060    /**
061     * Creates a new {@code AuditEvent} instance.
062     *
063     * @param src source of the event
064     * @param fileName file associated with the event
065     */
066    public AuditEvent(Object src, String fileName) {
067        this(src, fileName, null);
068    }
069
070    /**
071     * Creates a new {@code AuditEvent} instance.
072     *
073     * @param src source of the event
074     * @param fileName file associated with the event
075     * @param violation the actual violation
076     */
077    public AuditEvent(Object src, String fileName, Violation violation) {
078        super(src);
079        this.fileName = fileName;
080        this.violation = violation;
081    }
082
083    /**
084     * Returns name of file being audited.
085     *
086     * @return the file name currently being audited or null if there is
087     *     no relation to a file.
088     */
089    public String getFileName() {
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     *
097     * @return an integer representing the line number in the file source code.
098     */
099    public int getLine() {
100        return violation.getLineNo();
101    }
102
103    /**
104     * Return the violation associated to the event.
105     *
106     * @return the event violation
107     */
108    public String getMessage() {
109        return violation.getViolation();
110    }
111
112    /**
113     * Gets the column associated with the violation.
114     *
115     * @return the column associated with the violation
116     */
117    public int getColumn() {
118        return violation.getColumnNo();
119    }
120
121    /**
122     * Gets the audit event severity level.
123     *
124     * @return the audit event severity level
125     */
126    public SeverityLevel getSeverityLevel() {
127        SeverityLevel severityLevel = SeverityLevel.INFO;
128        if (violation != null) {
129            severityLevel = violation.getSeverityLevel();
130        }
131        return severityLevel;
132    }
133
134    /**
135     * Returns id of module.
136     *
137     * @return the identifier of the module that generated the event. Can return
138     *         null.
139     */
140    public String getModuleId() {
141        return violation.getModuleId();
142    }
143
144    /**
145     * Gets the name of the source for the violation.
146     *
147     * @return the name of the source for the violation
148     */
149    public String getSourceName() {
150        return violation.getSourceName();
151    }
152
153    /**
154     * Gets the violation.
155     *
156     * @return the violation
157     */
158    public Violation getViolation() {
159        return violation;
160    }
161
162}