PrintfRecord.java revision 91cfa10a8e55050a5103c4b2e83b0bf8d783a7cb
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * CDDL HEADER START
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * The contents of this file are subject to the terms of the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Common Development and Distribution License (the "License").
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * You may not use this file except in compliance with the License.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * See the License for the specific language governing permissions
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * and limitations under the License.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * When distributing Covered Code, include this CDDL HEADER in each
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * If applicable, add the following below this CDDL HEADER, with the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * fields enclosed by brackets "[]" replaced with your own identifying
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * information: Portions Copyright [yyyy] [name of copyright owner]
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * CDDL HEADER END
91cfa10a8e55050a5103c4b2e83b0bf8d783a7cbtomee * Copyright 2007 Sun Microsystems, Inc. All rights reserved.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Use is subject to license terms.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * ident "%Z%%M% %I% %E% SMI"
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * A formatted string generated by the DTrace {@code printf()} action.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Immutable. Supports persistence using {@link java.beans.XMLEncoder}.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @author Tom Erickson
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomeepublic final class PrintfRecord implements Record, Serializable {
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee static final long serialVersionUID = 727237355963977675L;
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee BeanInfo info = Introspector.getBeanInfo(PrintfRecord.class);
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee d.setValue("persistenceDelegate", persistenceDelegate);
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** @serial */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee /** @serial */
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee // package-level access, called by ProbeData
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Creates a record with the unformatted elements passed to the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * DTrace {@code printf()} action and the resulting formatted
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * output. Supports XML persistence.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @param v variable number of unformatted elements passed to the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * DTrace {@code printf()} action
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @param s formatted {@code printf()} output
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @throws NullPointerException if the given list or any of its
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * elements is {@code null}, or if the given formatted string is
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * {@code null}
91cfa10a8e55050a5103c4b2e83b0bf8d783a7cbtomee private final void
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee throw new NullPointerException("formatted string is null");
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee throw new NullPointerException("list of format args is null");
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee if (r == null) {
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Called by ProbeData code to populate record list.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @throws NullPointerException if o is null
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the formatted string output of the DTrace {@code printf()}
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return non-null formatted string output of the DTrace {@code
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * printf()} action
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Package level access; called by ProbeData
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee if (s == null) {
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee throw new NullPointerException("formatted string is null");
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the unfomatted elements passed to the DTrace {@code
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * printf()} action after the format string.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return non-null, unmodifiable list of unformatted elements
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * passed to the DTrace {@code printf()} action that generated this
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * record, in the order they appear in the argument list after the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * format string
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the number of DTrace {@code printf()} unformatted elements
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * (arguments following the format string). For example, the
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * following action
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * <pre><code>
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * printf("%s %d\n", "cat", 9);
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * </code></pre>
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * generates a {@code PrintfRecord} with a record count of two.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return the number of unformatted elements passed to the DTrace
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * {@code printf()} action that generated this record.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the unformatted element passed to the DTrace {@code
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * printf()} action at the given offset in the {@code printf()}
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * argument list after the format string, starting at offset zero
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * for the first unformatted element.
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @return non-null record representing the unformatted {@code
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * printf()} element at the given index (using the same order that
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * they appear in the {@code printf()} argument list)
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * @throws ArrayIndexOutOfBoundsException if the given index is
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * out of range (index < 0 || index >= getRecordCount())
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee private void
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee // Defensively copy record list before validating
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee throw new InvalidObjectException("record list is null");
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee List <ValueRecord> copy = new ArrayList <ValueRecord> (records.size());
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee // check invariants
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee } catch (Exception e) {
fb3fb4f3d76d55b64440afd0af72775dfad3bd1dtomee * Gets the formatted string output of the DTrace {@code printf()}