com.sun.tools.attach.AgentInitializationException Maven / Gradle / Ivy
Show all versions of common-agent-loader Show documentation
/*
* Copyright (c) 2005, 2006, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.tools.attach;
/**
* The exception thrown when an agent fails to initialize in the target
* Java virtual machine.
*
* This exception is thrown by {@link
* com.sun.tools.attach.VirtualMachine#loadAgent VirtualMachine.loadAgent},
* {@link com.sun.tools.attach.VirtualMachine#loadAgentLibrary
* VirtualMachine.loadAgentLibrary}, {@link
* com.sun.tools.attach.VirtualMachine#loadAgentPath VirtualMachine.loadAgentPath}
* methods if an agent, or agent library, cannot be initialized.
* When thrown by VirtualMachine.loadAgentLibrary, or
* VirtualMachine.loadAgentPath then the exception encapsulates
* the error returned by the agent's Agent_OnAttach function.
* This error code can be obtained by invoking the {@link #returnValue() returnValue} method.
*/
public class AgentInitializationException extends Exception {
/** use serialVersionUID for interoperability */
static final long serialVersionUID = -1508756333332806353L;
private int returnValue;
/**
* Constructs an AgentInitializationException with
* no detail message.
*/
public AgentInitializationException() {
super();
this.returnValue = 0;
}
/**
* Constructs an AgentInitializationException with
* the specified detail message.
*
* @param s the detail message.
*/
public AgentInitializationException(String s) {
super(s);
this.returnValue = 0;
}
/**
* Constructs an AgentInitializationException with
* the specified detail message and the return value from the
* execution of the agent's Agent_OnAttach function.
*
* @param s the detail message.
* @param returnValue the return value
*/
public AgentInitializationException(String s, int returnValue) {
super(s);
this.returnValue = returnValue;
}
/**
* If the exception was created with the return value from the agent
* Agent_OnAttach function then this returns that value,
* otherwise returns 0.
*
* @return the return value
*/
public int returnValue() {
return returnValue;
}
}