JavaClassNames (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.util.javalang.JavaClassNames

public class JavaClassNames
extends java.lang.Object

Constructor Summary

Constructors
Constructor and Description

JavaClassNames()

Constructors
Constructor and Description
`JavaClassNames()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`callerNiceClassAndMethod(int depth)` returns nice class name and method for the caller, going up the stack (filtered to remove invocation etc), with 0 typically being the context where this method is called, 1 being its caller, etc
`static java.lang.StackTraceElement`	`callerStackElement(int depth)` returns element in cleaned stack trace; usually the caller's location is at the top, and caller of that is up one, etc
`static java.lang.String`	`cleanSimpleClassName(java.lang.Class<?> x)` as `simpleClassName(Object)` but making the result clean for use on filesystems and as java identifiers
`static java.lang.String`	`cleanSimpleClassName(java.lang.Object x)` as `simpleClassName(Object)` but making the result clean for use on filesystems and as java identifiers
`static java.lang.Class<?>`	`componentType(java.lang.Object x)` like type, but removes any array modifiers
`static java.lang.StackTraceElement`	`currentStackElement()` returns top of cleaned stack trace; usually the caller's location
`static java.lang.StackTraceElement[]`	`currentStackTraceCleaned()` returns a cleaned stack trace; caller is usually at the top
`static java.lang.String`	`niceClassAndMethod()` convenience for `callerNiceClassAndMethod(int)` with depth 0
`static java.lang.String`	`niceClassAndMethod(java.lang.StackTraceElement st)` returns nice class name and method for the given element
`static java.lang.String`	`packageName(java.lang.Object x)`
`static java.lang.String`	`packagePath(java.lang.Object x)` returns e.g.
`static java.lang.String`	`resolveClasspathUrl(java.lang.Object context, java.lang.String path)` returns a "classpath:" URL given a context object and a file to be found in that directory or a sub-directory (ignoring the context object if the given path is absolute, i.e.
`static java.lang.String`	`resolveName(java.lang.Object context, java.lang.String path)` returns path relative to the package of x, unless path is absolute.
`static java.lang.String`	`simpleClassName(java.lang.Class<?> t)` returns a simplified name of the class, just the simple name if it seems useful, else the full name
`static java.lang.String`	`simpleClassName(java.lang.Object x)` as `simpleClassName(Class)` but taking the type of the object if it is not already a class or a type-token; callers should usually do the getClass themselves, unless they aren't sure whether it is already a Class-type object
`static java.lang.String`	`simplifyClassName(java.lang.String className)` as `simpleClassName(Class)` but taking a string rep'n of the class name, and doing best effort to simplify it (without instantiating)
`static java.lang.String`	`superSimpleClassName(java.lang.Class<?> t)` as `simpleClassName(Class)` but returning json types if appropriate, e.g.
`static java.lang.String`	`superSimpleClassName(java.lang.Object o)` as `simpleClassName(Object)` but looking up the type if needed
`static java.lang.Class<?>`	`type(java.lang.Object x)` returns the Class of anything which isn't a class; if input is class it is pass-through
`static java.lang.String`	`verySimpleClassName(java.lang.Class<?> t)` as `simpleClassName(Class)` but if something is an inner class it drops everything before the $

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - JavaClassNames
```
public JavaClassNames()
```
- Method Detail
  - type
```
public static java.lang.Class<?> type(java.lang.Object x)
```
    returns the Class of anything which isn't a class; if input is class it is pass-through
  - componentType
```
public static java.lang.Class<?> componentType(java.lang.Object x)
```
    like type, but removes any array modifiers
  - superSimpleClassName
```
public static java.lang.String superSimpleClassName(java.lang.Class<?> t)
```
    as simpleClassName(Class) but returning json types if appropriate, e.g. `map`, `string`, etc; else falling back to detailed type
  - superSimpleClassName
```
public static java.lang.String superSimpleClassName(java.lang.Object o)
```
    as simpleClassName(Object) but looking up the type if needed
  - simpleClassName
```
public static java.lang.String simpleClassName(java.lang.Class<?> t)
```
    returns a simplified name of the class, just the simple name if it seems useful, else the full name
  - verySimpleClassName
```
public static java.lang.String verySimpleClassName(java.lang.Class<?> t)
```
    as simpleClassName(Class) but if something is an inner class it drops everything before the $
  - simpleClassName
```
public static java.lang.String simpleClassName(java.lang.Object x)
```
    as simpleClassName(Class) but taking the type of the object if it is not already a class or a type-token; callers should usually do the getClass themselves, unless they aren't sure whether it is already a Class-type object
  - simplifyClassName
```
public static java.lang.String simplifyClassName(java.lang.String className)
```
    as simpleClassName(Class) but taking a string rep'n of the class name, and doing best effort to simplify it (without instantiating)
  - cleanSimpleClassName
```
public static java.lang.String cleanSimpleClassName(java.lang.Object x)
```
    as simpleClassName(Object) but making the result clean for use on filesystems and as java identifiers
  - cleanSimpleClassName
```
public static java.lang.String cleanSimpleClassName(java.lang.Class<?> x)
```
    as simpleClassName(Object) but making the result clean for use on filesystems and as java identifiers
  - packageName
```
public static java.lang.String packageName(java.lang.Object x)
```
  - packagePath
```
public static java.lang.String packagePath(java.lang.Object x)
```
    returns e.g. "/com/acme/" for an object in package com.acme
  - resolveName
```
public static java.lang.String resolveName(java.lang.Object context,
                                           java.lang.String path)
```
    returns path relative to the package of x, unless path is absolute. useful to mimic Class.getResource(path) behaviour, cf Class.resolveName where the first argument below is the class.
  - resolveClasspathUrl
```
public static java.lang.String resolveClasspathUrl(java.lang.Object context,
                                                   java.lang.String path)
```
    returns a "classpath:" URL given a context object and a file to be found in that directory or a sub-directory (ignoring the context object if the given path is absolute, i.e. starting with "/" or "protocol:") e.g. "classpath://com/acme/foo.txt" given a context object com.acme.SomeClass and "foo.txt"
  - currentStackTraceCleaned
```
public static java.lang.StackTraceElement[] currentStackTraceCleaned()
```
    returns a cleaned stack trace; caller is usually at the top
  - currentStackElement
```
public static java.lang.StackTraceElement currentStackElement()
```
    returns top of cleaned stack trace; usually the caller's location
  - callerStackElement
```
public static java.lang.StackTraceElement callerStackElement(int depth)
```
    returns element in cleaned stack trace; usually the caller's location is at the top, and caller of that is up one, etc
  - niceClassAndMethod
```
public static java.lang.String niceClassAndMethod(java.lang.StackTraceElement st)
```
    returns nice class name and method for the given element
  - callerNiceClassAndMethod
```
public static java.lang.String callerNiceClassAndMethod(int depth)
```
    returns nice class name and method for the caller, going up the stack (filtered to remove invocation etc), with 0 typically being the context where this method is called, 1 being its caller, etc
  - niceClassAndMethod
```
public static java.lang.String niceClassAndMethod()
```
    convenience for callerNiceClassAndMethod(int) with depth 0
    useful for tests and other debug-facing log messages!

Class JavaClassNames

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

JavaClassNames

Method Detail

type

componentType

superSimpleClassName

superSimpleClassName

simpleClassName

verySimpleClassName

simpleClassName

simplifyClassName

cleanSimpleClassName

cleanSimpleClassName

packageName

packagePath

resolveName

resolveClasspathUrl

currentStackTraceCleaned

currentStackElement

callerStackElement

niceClassAndMethod

callerNiceClassAndMethod

niceClassAndMethod