1 /******************************************************************************* 2 * Copyright (c) 2011, 2012 IBM Corporation and others. 3 * 4 * This program and the accompanying materials 5 * are made available under the terms of the Eclipse Public License 2.0 6 * which accompanies this distribution, and is available at 7 * https://www.eclipse.org/legal/epl-2.0/ 8 * 9 * SPDX-License-Identifier: EPL-2.0 10 * 11 * Contributors: 12 * IBM Corporation - initial API and implementation 13 *******************************************************************************/ 14 package org.eclipse.ui.trace.internal.utils; 15 16 /** 17 * A collection of constant values used by the tracing UI 18 */ 19 public class TracingConstants { 20 21 /** The name of the bundle */ 22 public final static String BUNDLE_ID = "org.eclipse.ui.trace"; //$NON-NLS-1$ 23 24 /** The separator for option paths in key=value pairs */ 25 public final static String DEBUG_OPTION_PATH_SEPARATOR = "="; //$NON-NLS-1$ 26 27 /** The value for a debug option that is disabled */ 28 public final static String DEBUG_OPTION_VALUE_FALSE = "false"; //$NON-NLS-1$ 29 30 /** The value for a debug option that is enabled **/ 31 public final static String DEBUG_OPTION_VALUE_TRUE = "true"; //$NON-NLS-1$ 32 33 /** Tracing Component extension point name */ 34 public final static String TRACING_EXTENSION_POINT_NAME = "traceComponents"; //$NON-NLS-1$ 35 36 /** The name of the 'id' attribute for a Tracing Component */ 37 public final static String TRACING_EXTENSION_ID_ATTRIBUTE = "id"; //$NON-NLS-1$ 38 39 /** The name of the 'label' attribute for a Tracing Component */ 40 public final static String TRACING_EXTENSION_LABEL_ATTRIBUTE = "label"; //$NON-NLS-1$ 41 42 /** The name of the 'bundle' attribute for a Tracing Component */ 43 public final static String TRACING_EXTENSION_BUNDLE_ATTRIBUTE = "bundle"; //$NON-NLS-1$ 44 45 /** The name of the 'name' attribute for a bundle in a Tracing Component */ 46 public final static String TRACING_EXTENSION_BUNDLE_NAME_ATTRIBUTE = "name"; //$NON-NLS-1$ 47 48 /** The name of the 'consumed' attribute for a bundle in a Tracing Component */ 49 public final static String TRACING_EXTENSION_BUNDLE_CONSUMED_ATTRIBUTE = "consumed"; //$NON-NLS-1$ 50 51 /** An empty {@link String} array **/ 52 public final static String[] EMPTY_STRING_ARRAY = new String[0]; 53 54 /** An empty {@link String} **/ 55 public final static String EMPTY_STRING = ""; //$NON-NLS-1$ 56 57 /** The index of the label column in the tree */ 58 public final static int LABEL_COLUMN_INDEX = 0; 59 60 /** The index of the value column in the tree */ 61 public final static int VALUE_COLUMN_INDEX = 1; 62 63 /** The name of the .options file used to store the debug options for a bundle */ 64 public final static String OPTIONS_FILENAME = ".options"; //$NON-NLS-1$ 65 66 /** The system property used to specify size a trace file can grow before it is rotated */ 67 public static final String PROP_TRACE_SIZE_MAX = "eclipse.trace.size.max"; //$NON-NLS-1$ 68 69 /** The system property used to specify the maximum number of backup trace files to use */ 70 public static final String PROP_TRACE_FILE_MAX = "eclipse.trace.backup.max"; //$NON-NLS-1$ 71 72 /** The separator character for a debug option represented as a string, i.e. key1=value1;key2=value2;key3=value3; */ 73 public final static String DEBUG_OPTION_PREFERENCE_SEPARATOR = ";"; //$NON-NLS-1$ 74 75 /** The preference identifier for the tracing enablement state */ 76 public final static String PREFERENCE_ENABLEMENT_IDENTIFIER = "tracingEnabled"; //$NON-NLS-1$ 77 78 /** The preference identifier for the list of tracing entries */ 79 public final static String PREFERENCE_ENTRIES_IDENTIFIER = "tracingEntries"; //$NON-NLS-1$ 80 81 /** The preference identifier for the maximum size of the tracing files */ 82 public final static String PREFERENCE_MAX_FILE_SIZE_IDENTIFIER = "tracingMaxFileSize"; //$NON-NLS-1$ 83 84 /** The preference identifier for the maximum number of tracing files */ 85 public final static String PREFERENCE_MAX_FILE_COUNT_IDENTIFIER = "tracingMaxFileCount"; //$NON-NLS-1$ 86 87 /** The preference identifier for the location of tracing files */ 88 public final static String PREFERENCE_FILE_PATH = "tracingFilePath"; //$NON-NLS-1$ 89 90 /** The preference identifier for standard output stream selection */ 91 public final static String PREFERENCE_OUTPUT_STANDARD_STREAM = "tracingOutputStandard"; //$NON-NLS-1$ 92 93 }