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

   1 /*******************************************************************************
   2  * Copyright (c) 2011, 2014 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.tracecompass.ctf.core.event.types;
  13
  14 import org.eclipse.jdt.annotation.NonNull;
  15 import org.eclipse.tracecompass.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  */
  23 public abstract class SimpleDatatypeDefinition extends Definition {
  24
  25     /**
  26      * Create a new SimpleDatatypeDefinition
  27      *
  28      * @param declaration
  29      *            definition's declaration
  30      * @param definitionScope
  31      *            The scope of this definition
  32      * @param fieldName
  33      *            The name of the field matching this definition in the parent
  34      *            scope
  35      */
  36     public SimpleDatatypeDefinition(@NonNull IDeclaration declaration, IDefinitionScope definitionScope,
  37             @NonNull String fieldName) {
  38         super(declaration, definitionScope, fieldName);
  39     }
  40
  41     /**
  42      * Gets the value in integer form
  43      *
  44      * @return the integer in a Long, can be null
  45      */
  46     public Long getIntegerValue() {
  47         return null;
  48     }
  49
  50     /**
  51      * Gets the value in string form
  52      *
  53      * @return the integer in a String, can be null
  54      */
  55     public String getStringValue() {
  56         return null;
  57     }
  58
  59 }