org.eclipse.tracecompass.ctf.core/src/org/eclipse/linuxtools/ctf/core/event/types/SimpleDatatypeDefinition.java

   1 /*******************************************************************************
   2  * Copyright (c) 2011, 2013 Ericsson, Ecole Polytechnique de Montreal and others
   3  *
   4  * All rights reserved. This program and the accompanying materials are made
   5  * available under the terms of the Eclipse Public License v1.0 which
   6  * accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors: Matthew Khouzam - Initial API and implementation
  10  *******************************************************************************/
  11
  12 package org.eclipse.linuxtools.ctf.core.event.types;
  13
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.eclipse.linuxtools.ctf.core.event.scope.IDefinitionScope;
  16
  17 /**
  18  * Simple Datatype definition is a datatype that allows the addition of
  19  * getIntegerValue and getStringValue to a class.
  20  *
  21  * @author Matthew Khouzam
  22  * @since 1.2
  23  */
  24 public abstract class SimpleDatatypeDefinition extends Definition {
  25
  26     /**
  27      * Create a new SimpleDatatypeDefinition
  28      *
  29      * @param declaration
  30      *            definition's declaration
  31      * @param definitionScope
  32      *            The scope of this definition
  33      * @param fieldName
  34      *            The name of the field matching this definition in the parent
  35      *            scope
  36      * @since 3.0
  37      */
  38     public SimpleDatatypeDefinition(@NonNull IDeclaration declaration, IDefinitionScope definitionScope,
  39             @NonNull String fieldName) {
  40         super(declaration, definitionScope, fieldName);
  41     }
  42
  43     /**
  44      * Gets the value in integer form
  45      *
  46      * @return the integer in a Long, can be null
  47      */
  48     public Long getIntegerValue() {
  49         return null;
  50     }
  51
  52     /**
  53      * Gets the value in string form
  54      *
  55      * @return the integer in a String, can be null
  56      */
  57     public String getStringValue() {
  58         return null;
  59     }
  60
  61 }