Inspector (groovy 2.4.4 API)

groovy.inspect.Inspector

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`Inspector.MemberComparator`

Field Summary

Fields
Modifiers	Name	Description
`static int`	`CLASS_CLASS_IDX`
`static int`	`CLASS_INTERFACE_IDX`
`static int`	`CLASS_OTHER_IDX`
`static int`	`CLASS_PACKAGE_IDX`
`static int`	`CLASS_SUPERCLASS_IDX`
`static String`	`GROOVY`
`static String`	`JAVA`
`static int`	`MEMBER_DECLARER_IDX`
`static int`	`MEMBER_EXCEPTIONS_IDX`
`static int`	`MEMBER_MODIFIER_IDX`
`static int`	`MEMBER_NAME_IDX`
`static int`	`MEMBER_ORIGIN_IDX`
`static int`	`MEMBER_PARAMS_IDX`
`static int`	`MEMBER_TYPE_IDX`
`static int`	`MEMBER_VALUE_IDX`
`static String`	`NOT_APPLICABLE`
`protected Object`	`objectUnderInspection`

Constructor Summary

Constructors
Constructor and description
`Inspector (Object objectUnderInspection)` @param objectUnderInspection must not be null

Methods Summary

Methods
Type	Name and description
`protected String[]`	`fieldInfo(Field field)`
`protected String[]`	`fieldInfo(PropertyValue pv)`
`String[]`	`getClassProps()` Get the Class Properties of the object under inspection.
`protected Class`	`getClassUnderInspection()`
`Object[]`	`getMetaMethods()` Get info about instance and class Methods that are dynamically added through Groovy.
`Object[]`	`getMethods()` Get info about usual Java instance and class Methods as well as Constructors.
`Object`	`getObject()` Gets the object being inspected.
`Object[]`	`getPropertyInfo()` Get info about Properties (Java and Groovy alike).
`Object[]`	`getPublicFields()` Get info about usual Java public fields incl. constants.
`boolean`	`isGroovy()`
`protected String[]`	`methodInfo(Method method)`
`protected String[]`	`methodInfo(Constructor ctor)`
`protected String[]`	`methodInfo(MetaMethod method)`
`static void`	`print(Object[] memberInfo)`
`static String`	`shortName(Class clazz)`
`static Collection`	`sort(List<Object> memberInfo)`
`protected String[]`	`withoutNulls(String[] toNormalize)`

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`wait, wait, wait, equals, toString, hashCode, getClass, notify, notifyAll`

- Field Detail
  - public static final int CLASS_CLASS_IDX
  - public static final int CLASS_INTERFACE_IDX
  - public static final int CLASS_OTHER_IDX
  - public static final int CLASS_PACKAGE_IDX
  - public static final int CLASS_SUPERCLASS_IDX
  - public static final String GROOVY
  - public static final String JAVA
  - public static final int MEMBER_DECLARER_IDX
  - public static final int MEMBER_EXCEPTIONS_IDX
  - public static final int MEMBER_MODIFIER_IDX
  - public static final int MEMBER_NAME_IDX
  - public static final int MEMBER_ORIGIN_IDX
  - public static final int MEMBER_PARAMS_IDX
  - public static final int MEMBER_TYPE_IDX
  - public static final int MEMBER_VALUE_IDX
  - public static final String NOT_APPLICABLE
  - protected Object objectUnderInspection
- Constructor Detail
  - public Inspector(Object objectUnderInspection)
    
    Parameters:
    objectUnderInspection - must not be null
- Method Detail
  - protected String[] fieldInfo(Field field)
  - protected String[] fieldInfo(PropertyValue pv)
  - public String[] getClassProps()
    
    Get the Class Properties of the object under inspection.
    Returns:
    String array to be indexed by the CLASS_xxx_IDX constants
  - protected Class getClassUnderInspection()
  - public Object[] getMetaMethods()
    
    Get info about instance and class Methods that are dynamically added through Groovy.
    Returns:
    Array of StringArrays that can be indexed with the MEMBER_xxx_IDX constants
  - public Object[] getMethods()
    
    Get info about usual Java instance and class Methods as well as Constructors.
    Returns:
    Array of StringArrays that can be indexed with the MEMBER_xxx_IDX constants
  - public Object getObject()
    
    Gets the object being inspected.
    Returns:
    the object
  - public Object[] getPropertyInfo()
    
    Get info about Properties (Java and Groovy alike).
    Returns:
    Array of StringArrays that can be indexed with the MEMBER_xxx_IDX constants
  - public Object[] getPublicFields()
    
    Get info about usual Java public fields incl. constants.
    Returns:
    Array of StringArrays that can be indexed with the MEMBER_xxx_IDX constants
  - public boolean isGroovy()
  - protected String[] methodInfo(Method method)
  - protected String[] methodInfo(Constructor ctor)
  - protected String[] methodInfo(MetaMethod method)
  - public static void print(Object[] memberInfo)
  - public static String shortName(Class clazz)
  - public static Collection sort(List<Object> memberInfo)
  - protected String[] withoutNulls(String[] toNormalize)

| Detail:
Field
Constructor
Method

[Java] Class Inspector

Nested Class Summary

Field Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final int CLASS_CLASS_IDX

public static final int CLASS_INTERFACE_IDX

public static final int CLASS_OTHER_IDX

public static final int CLASS_PACKAGE_IDX

public static final int CLASS_SUPERCLASS_IDX

public static final String GROOVY

public static final String JAVA

public static final int MEMBER_DECLARER_IDX

public static final int MEMBER_EXCEPTIONS_IDX

public static final int MEMBER_MODIFIER_IDX

public static final int MEMBER_NAME_IDX

public static final int MEMBER_ORIGIN_IDX

public static final int MEMBER_PARAMS_IDX

public static final int MEMBER_TYPE_IDX

public static final int MEMBER_VALUE_IDX

public static final String NOT_APPLICABLE

protected Object objectUnderInspection

Constructor Detail

public Inspector(Object objectUnderInspection)

Method Detail

protected String[] fieldInfo(Field field)

protected String[] fieldInfo(PropertyValue pv)

public String[] getClassProps()

protected Class getClassUnderInspection()

public Object[] getMetaMethods()

public Object[] getMethods()

public Object getObject()

public Object[] getPropertyInfo()

public Object[] getPublicFields()

public boolean isGroovy()

protected String[] methodInfo(Method method)

protected String[] methodInfo(Constructor ctor)

protected String[] methodInfo(MetaMethod method)

public static void print(Object[] memberInfo)

public static String shortName(Class clazz)

public static Collection sort(List<Object> memberInfo)

protected String[] withoutNulls(String[] toNormalize)