StringToDocRef (Nuxeo 2021.1.19 API Documentation)

java.lang.Object
- org.nuxeo.ecm.automation.core.impl.adapters.StringToDocRef

All Implemented Interfaces:: TypeAdapter

public class StringToDocRef
extends Object
implements TypeAdapter

Author:: Bogdan Stefanescu

Constructor Summary

Constructors
Constructor Description

StringToDocRef()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static DocumentRef`	`createRef(String value)`	Deprecated. since 9.1, see `TypeAdapterHelper.createDocumentRef(String)` instead
`DocumentRef`	`getAdaptedValue(OperationContext ctx, Object objectToAdapt)`	Adapt the given object to an instance of the given target type.

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

- Constructor Detail
  - StringToDocRef
```
public StringToDocRef()
```
- Method Detail
  - getAdaptedValue
```
public DocumentRef getAdaptedValue(OperationContext ctx,
                                   Object objectToAdapt)
                            throws TypeAdaptException
```
    Description copied from interface: TypeAdapter
    
    Adapt the given object to an instance of the given target type. The input object cannot be null. Throws an exception if the object cannot be adapted.
    
    Specified by:
    
    getAdaptedValue in interface TypeAdapter
    
    Throws:
    
    TypeAdaptException - when the object cannot be adapted
  - createRef
```
@Deprecated
public static DocumentRef createRef(String value)
```
    Deprecated.
    since 9.1, see TypeAdapterHelper.createDocumentRef(String) instead