MonitoredAttributeInfo.java revision 608:7e06bf1dcb09 
1/*
2 * Copyright (c) 2003, 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 */
25package com.sun.corba.se.spi.monitoring;
26
27import java.util.*;
28
29/**
30 * <p>
31 *
32 * @author Hemanth Puttaswamy
33 * </p>
34 * <p>
35 * Monitored AttributeInfo contains the meta information of the Monitored
36 * Attribute.
37 * </p>
38 */
39public interface MonitoredAttributeInfo {
40
41  ///////////////////////////////////////
42  // operations
43
44/**
45 * <p>
46 * If the Attribute is writable from ASAdmin then isWritable() will return
47 * true.
48 * </p>
49 * <p>
50 *
51 * @return a boolean with true or false
52 * </p>
53 */
54    public boolean isWritable();
55/**
56 * <p>
57 * isStatistic() is true if the attribute is presented as a Statistic.
58 * </p>
59 * <p>
60 *
61 * @return a boolean with true or false
62 * </p>
63 */
64    public boolean isStatistic();
65/**
66 * <p>
67 * Class Type: We will allow only basic class types: 1)Boolean 2)Integer
68 * 3)Byte 4)Long 5)Float 6)Double 7)String 8)Character
69 * </p>
70 * <p>
71 *
72 * @return a Class Type
73 * </p>
74 */
75    public Class type();
76/**
77 * <p>
78 * Get's the description for the Monitored Attribute.
79 * </p>
80 * <p>
81 *
82 * @return a String with description
83 * </p>
84 */
85    public String getDescription();
86
87} // end MonitoredAttributeInfo
88