ProgramInfo.java revision 4ae67516a1d5dc4a5dbc761762bad5b596647388
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*
* ident "%Z%%M% %I% %E% SMI"
*/
/**
* Information about a {@link Program} including stability and matching
* probe count.
* <p>
* Immutable. Supports persistence using {@link java.beans.XMLEncoder}.
*
* @see Consumer#getProgramInfo(Program program)
* @see Consumer#enable(Program program)
*
* @author Tom Erickson
*/
public final class ProgramInfo implements Serializable {
static final long serialVersionUID = 663862981171935056L;
static {
try {
new String[] { "minimumProbeAttributes",
"minimumStatementAttributes",
"matchingProbeCount" })
{
/*
* Need to prevent DefaultPersistenceDelegate from using
* overridden equals() method, resulting in a
* StackOverFlowError. Revert to PersistenceDelegate
* implementation. See
* 477019&tstart=135
*/
protected boolean
{
}
};
} catch (IntrospectionException e) {
e.printStackTrace();
}
}
/** @serial */
private final InterfaceAttributes minimumProbeAttributes;
/** @serial */
private final InterfaceAttributes minimumStatementAttributes;
/** @serial */
private final int matchingProbeCount;
/**
* Creates a {@code ProgamInfo} instance with the given properties.
* Supports XML persistence.
*
* @param minProbeAttr minimum stability levels of the
* program probe descriptions
* @param minStatementAttr minimum stability levels of the
* program action statements (including D variables)
* @param matchingProbes non-negative count of probes matching the
* program probe description
* @throws NullPointerException if {@code minProbeAttr} or {@code
* minStatementAttr} is {@code null}
* @throws IllegalArgumentException if {@code matchingProbes} is
* negative
*/
public
int matchingProbes)
{
// Called by native code. Any change to this constructor requires a
// similar change in the native invocation.
validate();
}
private final void
validate()
{
if (minimumProbeAttributes == null) {
throw new NullPointerException("minimumProbeAttributes is null");
}
if (minimumStatementAttributes == null) {
throw new NullPointerException(
"minimumStatementAttributes is null");
}
if (matchingProbeCount < 0) {
throw new IllegalArgumentException(
"matchingProbeCount is negative");
}
}
/**
* Gets the minimum stability levels of the probe descriptions used
* in a compiled {@link Program}.
*
* @return non-null interface attributes describing the minimum
* stability of the probe descriptions in a D program
*/
public InterfaceAttributes
{
return minimumProbeAttributes;
}
/**
* Gets the minimum stability levels of the action statements
* including D variables used in a compiled {@link Program}.
*
* @return non-null interface attributes describing the minimum
* stability of the action statements (including D variables) in a D
* program
*/
public InterfaceAttributes
{
return minimumStatementAttributes;
}
/**
* Gets the number of DTrace probes that match the probe
* descriptions in a compiled {@link Program}. This count may be
* very high for programs that use {@link ProbeDescription}
* wildcarding (field omission) and globbing (pattern matching
* syntax).
*
* @return non-negative count of probes on the system matching the
* program descriptions in a compiled D program
*/
public int
{
return matchingProbeCount;
}
/**
* Compares the specified object with this program information for
* equality. Defines equality as having the same information,
* including stability attributes and matching probe counts.
* Different D programs may have equal program information.
*
* @return {@code true} if and only if the specified object is also
* a {@code ProgramInfo} instance and has all the same information
* as this instance
*/
public boolean
{
if (o == this) {
return true;
}
if (o instanceof ProgramInfo) {
ProgramInfo i = (ProgramInfo)o;
return (minimumProbeAttributes.equals(
i.minimumProbeAttributes) &&
(matchingProbeCount == i.matchingProbeCount));
}
return false;
}
/**
* Overridden to ensure that equal {@code ProgramInfo} instances
* have equal hashcodes.
*/
public int
hashCode()
{
int hash = 17;
return hash;
}
private void
throws IOException, ClassNotFoundException
{
s.defaultReadObject();
// Check constructor invariants
try {
validate();
} catch (Exception e) {
e.getMessage());
x.initCause(e);
throw x;
}
}
/**
* Gets a string representation of this {@code ProgramInfo} useful
* for logging and not intended for display. The exact details of
* the representation are unspecified and subject to change, but the
* following format may be regarded as typical:
* <pre><code>
* class-name[property1 = value1, property2 = value2]
* </code></pre>
*/
public String
toString()
{
}
}