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