View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.impl;
18  
19  import java.io.Serializable;
20  
21  /**
22   * Package data for a StackTraceElement.
23   */
24  public class StackTracePackageElement implements Serializable {
25  
26      private static final long serialVersionUID = -2171069569241280505L;
27  
28      private final String location;
29  
30      private final String version;
31  
32      private final boolean isExact;
33  
34      /**
35       * Constructor that takes the location, version, and exact match flag.
36       * @param location The location of the Class.
37       * @param version The version of the component.
38       * @param exact if true this is an exact package element.
39       */
40      public StackTracePackageElement(final String location, final String version, final boolean exact) {
41          this.location = location;
42          this.version = version;
43          this.isExact = exact;
44      }
45  
46      /**
47       * Returns the location of the element.
48       * @return The location of the element.
49       */
50      public String getLocation() {
51          return location;
52      }
53  
54      /**
55       * Returns the version of the element.
56       * @return the version of the element.
57       */
58      public String getVersion() {
59          return version;
60      }
61  
62      /**
63       * Returns the indicator of whether this is an exact match.
64       * @return true if the location was determined exactly.
65       */
66      public boolean isExact() {
67          return isExact;
68      }
69  
70      @Override
71      public String toString() {
72          final String exact = isExact ? "" : "~";
73          return exact + "[" + location + ":" + version + "]";
74      }
75  }