OLD | NEW |
1 // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2014, the Dart project authors. Please see the AUTHORS file |
2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
4 | 4 |
5 library barback.transformer.declaring_transformer; | 5 library barback.declaring_transformer; |
6 | 6 |
7 import 'dart:async'; | 7 import 'dart:async'; |
8 | 8 |
9 import 'declaring_transform.dart'; | 9 import 'declaring_transform.dart'; |
10 | 10 |
11 /// An interface for [Transformer]s that can cheaply figure out which assets | 11 /// An interface for [Transformer]s that can cheaply figure out which assets |
12 /// they'll emit without doing the work of actually creating those assets. | 12 /// they'll emit without doing the work of actually creating those assets. |
13 /// | 13 /// |
14 /// If a transformer implements this interface, that allows barback to perform | 14 /// If a transformer implements this interface, that allows barback to perform |
15 /// optimizations to make the asset graph work more smoothly. | 15 /// optimizations to make the asset graph work more smoothly. |
16 abstract class DeclaringTransformer { | 16 abstract class DeclaringTransformer { |
17 /// Declare which assets would be emitted for the primary input id specified | 17 /// Declare which assets would be emitted for the primary input id specified |
18 /// by [transform]. | 18 /// by [transform]. |
19 /// | 19 /// |
20 /// This works a little like [Transformer.apply], with two main differences. | 20 /// This works a little like [Transformer.apply], with two main differences. |
21 /// First, instead of having access to the primary input's contents, it only | 21 /// First, instead of having access to the primary input's contents, it only |
22 /// has access to its id. Second, instead of emitting [Asset]s, it just emits | 22 /// has access to its id. Second, instead of emitting [Asset]s, it just emits |
23 /// [AssetId]s through [transform.addOutputId]. | 23 /// [AssetId]s through [transform.addOutputId]. |
24 /// | 24 Future declareOutputs(DeclaringTransform transform); |
25 /// If this does asynchronous work, it should return a [Future] that completes | |
26 /// once it's finished. | |
27 declareOutputs(DeclaringTransform transform); | |
28 } | 25 } |
OLD | NEW |