1 /*
   2  * Copyright (c) 1999, 2011, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 /*
  27  * This source code is provided to illustrate the usage of a given feature
  28  * or technique and has been deliberately simplified. Additional steps
  29  * required for a production-quality application, such as security checks,
  30  * input validation and proper error handling, might not be present in
  31  * this sample code.
  32  */
  33 
  34 
  35 package com.sun.tools.example.debug.bdi;
  36 
  37 import com.sun.jdi.*;
  38 import java.util.List;
  39 
  40 public class LineBreakpointSpec extends BreakpointSpec {
  41     int lineNumber;
  42 
  43     LineBreakpointSpec(EventRequestSpecList specs,
  44                        ReferenceTypeSpec refSpec, int lineNumber) {
  45         super(specs, refSpec);
  46         this.lineNumber = lineNumber;
  47     }
  48 
  49     /**
  50      * The 'refType' is known to match.
  51      */
  52     @Override
  53     void resolve(ReferenceType refType) throws InvalidTypeException,
  54                                              LineNotFoundException {
  55         if (!(refType instanceof ClassType)) {
  56             throw new InvalidTypeException();
  57         }
  58         Location location = location((ClassType)refType);
  59         setRequest(refType.virtualMachine().eventRequestManager()
  60                    .createBreakpointRequest(location));
  61     }
  62 
  63     private Location location(ClassType clazz) throws
  64                                             LineNotFoundException {
  65         Location location = null;
  66         try {
  67             List<Location> locs = clazz.locationsOfLine(lineNumber());
  68             if (locs.size() == 0) {
  69                 throw new LineNotFoundException();
  70             }
  71             // TODO handle multiple locations
  72             location = locs.get(0);
  73             if (location.method() == null) {
  74                 throw new LineNotFoundException();
  75             }
  76         } catch (AbsentInformationException e) {
  77             /*
  78              * TO DO: throw something more specific, or allow
  79              * AbsentInfo exception to pass through.
  80              */
  81             throw new LineNotFoundException();
  82         }
  83         return location;
  84     }
  85 
  86     public int lineNumber() {
  87         return lineNumber;
  88     }
  89 
  90     @Override
  91     public int hashCode() {
  92         return refSpec.hashCode() + lineNumber;
  93     }
  94 
  95     @Override
  96     public boolean equals(Object obj) {
  97         if (obj instanceof LineBreakpointSpec) {
  98             LineBreakpointSpec breakpoint = (LineBreakpointSpec)obj;
  99 
 100             return refSpec.equals(breakpoint.refSpec) &&
 101                    (lineNumber == breakpoint.lineNumber);
 102         } else {
 103             return false;
 104         }
 105     }
 106 
 107     @Override
 108     public String errorMessageFor(Exception e) {
 109         if (e instanceof LineNotFoundException) {
 110             return ("No code at line " + lineNumber() + " in " + refSpec);
 111         } else if (e instanceof InvalidTypeException) {
 112             return ("Breakpoints can be located only in classes. " +
 113                         refSpec + " is an interface or array");
 114         } else {
 115             return super.errorMessageFor( e);
 116         }
 117     }
 118 
 119     @Override
 120     public String toString() {
 121         StringBuilder sb = new StringBuilder("breakpoint ");
 122         sb.append(refSpec.toString());
 123         sb.append(':');
 124         sb.append(lineNumber);
 125         sb.append(" (");
 126         sb.append(getStatusString());
 127         sb.append(')');
 128         return sb.toString();
 129     }
 130 }