OctaveEngine.NameDesc (javaoctave 0.7.1 API)

java.lang.Object
- eu.simuline.octave.OctaveEngine.NameDesc

Enclosing class:

OctaveEngine
```
public static class OctaveEngine.NameDesc
extends Object
```
Describes the meaning of a name, if any. That name is replicated in name. The category is given in category. If it is OctaveEngine.NameDesc.Category.Unknown, both type and file are null. From now on assume it is not unknown.
If name is a OctaveEngine.NameDesc.Category.Variable, of course no file is attached and also no type. TBD: change that. The type can be found out using typeinfo(name). From now on assume name is not a variable.
If name points to an existing file file, the category is OctaveEngine.NameDesc.Category.FileEx, no matter whether a directory or a proper file and type is null.
If the name points to an object with a type defined by a file (seemingly function types only), then the category is OctaveEngine.NameDesc.Category.TypedDefInFile. Then of course, type determines the type and file the file, both not null. CAUTION: file may not exist (for built-in functions).
There is a last case name has a type type but is not defined by a file. TBD: clarify when this occurs. In that case the category is OctaveEngine.NameDesc.Category.TypedWithoutFile.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class OctaveEngine.NameDesc.Category

Field Summary

Fields
Modifier and Type	Field	Description
`OctaveEngine.NameDesc.Category`	`category`	The category of the `name` described by this object.
`File`	`file`	The file of the object tied to `name`.
`String`	`name`	The name which is described by this `OctaveEngine.NameDesc`.
`String`	`type`	The type of the object tied to `name`.

Constructor Summary

Constructors
Constructor Description

NameDesc(Matcher matcher, String name)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type Method Description

String toString()
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
public final String name
```
    The name which is described by this OctaveEngine.NameDesc.
  - category
```
public final OctaveEngine.NameDesc.Category category
```
    The category of the name described by this object.
  - type
```
public final String type
```
    The type of the object tied to name. This may be null, depending on category. Seemingly, "function" represents the type "user-defined function". Seemingly, else this is a type as returned by 'typeinfo'.
  - file
```
public final File file
```
    The file of the object tied to name. This may be null, depending on category. If this is a function defined by an m-file, this is the location of that m-file. Then the type is 'function', meaning 'user defined function'. For built-in functions this seems to be something rooted in "libinterp" but without leading file separator if returned by which. Thus for built-in functions, this 'file' does not exist. Nevertheless, these functions seem to be all defined in liboctinterp.so (linux).
- Constructor Detail
  - NameDesc
```
NameDesc(Matcher matcher,
         String name)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object