Index (pg-index-health 0.1.8 API)

java.lang.Object
- io.github.mfvanek.pg.model.Index

All Implemented Interfaces:

IndexNameAware, TableNameAware

Direct Known Subclasses:

IndexWithSize
```
public class Index
extends java.lang.Object
implements TableNameAware, IndexNameAware
```
A base representation of database index.

See Also:

TableNameAware, IndexNameAware

Constructor Summary

Constructors
Modifier Constructor Description

protected Index(java.lang.String tableName, java.lang.String indexName)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getIndexName()`	Gets index name.
`java.lang.String`	`getTableName()`	Gets table name.
`int`	`hashCode()`
`protected java.lang.String`	`innerToString()`
`static Index`	`of(java.lang.String tableName, java.lang.String indexName)`	Constructs an `Index` object.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Index

protected Index(@Nonnull
                java.lang.String tableName,
                @Nonnull
                java.lang.String indexName)

Method Detail
- getTableName
```
@Nonnull
public java.lang.String getTableName()
```
  Gets table name.
  
  Specified by:
  
  getTableName in interface TableNameAware
  
  Returns:
  
  table name
- getIndexName
```
@Nonnull
public java.lang.String getIndexName()
```
  Gets index name.
  
  Specified by:
  
  getIndexName in interface IndexNameAware
  
  Returns:
  
  index name
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object
- innerToString
```
protected java.lang.String innerToString()
```
- equals
```
public boolean equals(java.lang.Object o)
```
  Overrides:
  
  equals in class java.lang.Object
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- of
```
public static Index of(@Nonnull
                       java.lang.String tableName,
                       @Nonnull
                       java.lang.String indexName)
```
  Constructs an Index object.
  
  Parameters:
  
  tableName - table name; should be non blank.
  
  indexName - index name; should be non blank.
  
  Returns:
  
  Index