parser/yang-parser-api/src/main/java/org/opendaylight/yangtools/yang/model/parser/api/YangSyntaxErrorException.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.parser.api;
   9
  10 import java.util.Optional;
  11 import org.eclipse.jdt.annotation.NonNull;
  12 import org.eclipse.jdt.annotation.Nullable;
  13 import org.opendaylight.yangtools.yang.model.repo.api.SourceIdentifier;
  14
  15 @Deprecated(since = "7.0.0", forRemoval = true)
  16 public class YangSyntaxErrorException extends YangParserException {
  17     private static final long serialVersionUID = 2L;
  18
  19     private final SourceIdentifier source;
  20     private final int line;
  21     private final int charPositionInLine;
  22
  23     public YangSyntaxErrorException(final @Nullable SourceIdentifier source, final int line,
  24             final int charPositionInLine, final String message) {
  25         this(source, line, charPositionInLine, message, null);
  26     }
  27
  28     public YangSyntaxErrorException(final @Nullable SourceIdentifier source, final int line,
  29             final int charPositionInLine, final String message, final @Nullable Throwable cause) {
  30         super(message, cause);
  31         this.source = source;
  32         this.line = line;
  33         this.charPositionInLine = charPositionInLine;
  34     }
  35
  36     public final Optional<SourceIdentifier> getSource() {
  37         return Optional.ofNullable(source);
  38     }
  39
  40     public final int getLine() {
  41         return line;
  42     }
  43
  44     public final int getCharPositionInLine() {
  45         return charPositionInLine;
  46     }
  47
  48     public @NonNull String getFormattedMessage() {
  49         final StringBuilder sb = new StringBuilder(getMessage());
  50         if (source != null) {
  51             sb.append(" in source ");
  52             sb.append(source);
  53         }
  54         if (line != 0) {
  55             sb.append(" on line ");
  56             sb.append(line);
  57             if (charPositionInLine != 0) {
  58                 sb.append(" character ");
  59                 sb.append(charPositionInLine);
  60             }
  61         }
  62         return sb.toString();
  63     }
  64
  65     @Override
  66     public String toString() {
  67         return this.getClass().getName() + ": " + getFormattedMessage();
  68     }
  69 }