1 /*
2 * Copyright (C) 2012 Atlassian
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package com.atlassian.jira.rest.client.api.domain.input;
18
19 import com.google.common.base.Function;
20
21 import javax.annotation.Nullable;
22
23 /**
24 * Implement this interface if you want to provide your own value transformer to ValueTransformerManager.
25 * <p>
26 * You should return {@link ValueTransformer#CANNOT_HANDLE} in {@link ValueTransformer#apply(Object)} when implemented
27 * transformer cannot transform given value.
28 *
29 * @since v1.0
30 */
31 public interface ValueTransformer extends Function<Object, Object> {
32 public static final Object CANNOT_HANDLE = new Object();
33
34 /**
35 * Transform given object into other representation, that can be used as input for field value generators.
36 *
37 * @param from Source object.
38 * @return The resulting object or {@link ValueTransformer#CANNOT_HANDLE} when given value cannot be transformed.
39 */
40 @Override
41 Object apply(@Nullable Object from);
42 }