Repository: zest-java Updated Branches: refs/heads/develop def7765f4 -> c24ab017b
Added a little bit of documentation about Objects. Removed Copyright holder names. Project: http://git-wip-us.apache.org/repos/asf/zest-java/repo Commit: http://git-wip-us.apache.org/repos/asf/zest-java/commit/c24ab017 Tree: http://git-wip-us.apache.org/repos/asf/zest-java/tree/c24ab017 Diff: http://git-wip-us.apache.org/repos/asf/zest-java/diff/c24ab017 Branch: refs/heads/develop Commit: c24ab017baf040f471da195ba0be5392f1554cae Parents: def7765 Author: Niclas Hedhman <[email protected]> Authored: Fri Apr 15 12:37:24 2016 +0800 Committer: Niclas Hedhman <[email protected]> Committed: Fri Apr 15 12:37:24 2016 +0800 ---------------------------------------------------------------------- core/api/src/docs/api.txt | 6 ++-- core/api/src/docs/application.txt | 2 -- core/api/src/docs/composition.txt | 2 -- core/api/src/docs/concern.txt | 2 -- core/api/src/docs/configuration.txt | 2 -- core/api/src/docs/constraint.txt | 2 -- core/api/src/docs/decoratormixin.txt | 2 -- core/api/src/docs/entitycomposite.txt | 2 -- core/api/src/docs/fragment.txt | 2 -- core/api/src/docs/metrics.txt | 2 -- core/api/src/docs/mixin.txt | 2 -- core/api/src/docs/module.txt | 2 -- core/api/src/docs/objects.txt | 41 +++++++++++++++++++++++++++ core/api/src/docs/servicecomposite.txt | 2 -- core/api/src/docs/sideeffect.txt | 2 -- core/api/src/docs/structure.txt | 2 -- core/api/src/docs/transientcomposite.txt | 2 -- core/api/src/docs/unitofwork.txt | 2 -- core/api/src/docs/valuecomposite.txt | 3 -- 19 files changed, 45 insertions(+), 37 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/api.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/api.txt b/core/api/src/docs/api.txt index e3825b8..4b6d303 100644 --- a/core/api/src/docs/api.txt +++ b/core/api/src/docs/api.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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 @@ -60,6 +58,10 @@ include::transientcomposite.txt[] :leveloffset: {level3} +include::objects.txt[] + +:leveloffset: {level3} + // include::dependency-injection.txt[] :leveloffset: {level3} http://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/application.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/application.txt b/core/api/src/docs/application.txt index 2deb3b2..1525127 100644 --- a/core/api/src/docs/application.txt +++ b/core/api/src/docs/application.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/composition.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/composition.txt b/core/api/src/docs/composition.txt index 68779fe..eeb0bc2 100644 --- a/core/api/src/docs/composition.txt +++ b/core/api/src/docs/composition.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/concern.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/concern.txt b/core/api/src/docs/concern.txt index 47e0ac7..16e43b5 100644 --- a/core/api/src/docs/concern.txt +++ b/core/api/src/docs/concern.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2013, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/configuration.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/configuration.txt b/core/api/src/docs/configuration.txt index dd4f84f..054504d 100644 --- a/core/api/src/docs/configuration.txt +++ b/core/api/src/docs/configuration.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/constraint.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/constraint.txt b/core/api/src/docs/constraint.txt index 3fe8869..5ec8c34 100644 --- a/core/api/src/docs/constraint.txt +++ b/core/api/src/docs/constraint.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/decoratormixin.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/decoratormixin.txt b/core/api/src/docs/decoratormixin.txt index 77ed241..4c34637 100644 --- a/core/api/src/docs/decoratormixin.txt +++ b/core/api/src/docs/decoratormixin.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/entitycomposite.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/entitycomposite.txt b/core/api/src/docs/entitycomposite.txt index b445f4b..92dd884 100644 --- a/core/api/src/docs/entitycomposite.txt +++ b/core/api/src/docs/entitycomposite.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/fragment.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/fragment.txt b/core/api/src/docs/fragment.txt index 020fd15..3edbf3b 100644 --- a/core/api/src/docs/fragment.txt +++ b/core/api/src/docs/fragment.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/metrics.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/metrics.txt b/core/api/src/docs/metrics.txt index 3f81ea1..c5d26d5 100644 --- a/core/api/src/docs/metrics.txt +++ b/core/api/src/docs/metrics.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/mixin.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/mixin.txt b/core/api/src/docs/mixin.txt index 989b7cd..918f1fb 100644 --- a/core/api/src/docs/mixin.txt +++ b/core/api/src/docs/mixin.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/module.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/module.txt b/core/api/src/docs/module.txt index 97a7aef..eb191a9 100644 --- a/core/api/src/docs/module.txt +++ b/core/api/src/docs/module.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/objects.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/objects.txt b/core/api/src/docs/objects.txt new file mode 100644 index 0000000..8dbc654 --- /dev/null +++ b/core/api/src/docs/objects.txt @@ -0,0 +1,41 @@ +////////////////////// + * Licensed 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. +////////////////////// + +[[core-api-value,Object]] += Objects = +There are times when Apache Zest needs to interoperate with other systems, which +does not have interfaces as their abstraction. Zest has a notion of +Objects, which are Zest-managed classes and can still be injected with +the Zest runtime model, such as @Structure and @Service. + + +The characteristics of an Object compared to Composite meta types are; + + * It is a Class, not an interface. + * It can have injections applied to it after it has been created. + * No Mixins, Concerns or SideEffects. + * No Constraints. + * Can not have Property instances managed by the Zest runtime. + +== Serialization == +Objects can be serialized and deserialized using the ValueSerialization API, if and only +if they are used as types in Properties in Values or Entities. It depends on the +ValueSerialization implementation on how the objects are serialized, and +what the requirements are to allow for deserialization. In general, the Spring +POJO setter/getter approach will always work, a default constructor is needed, and +to be safe, make it into +java.io.Serializable+. + +== Usage == +Objects are instantiated either by calling +ObjectFactory.newObject( type, ... )+ or +instantiating it in some other fashion and then call +ObjectFactory.injectInto(...)+ +to populate the fields. http://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/servicecomposite.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/servicecomposite.txt b/core/api/src/docs/servicecomposite.txt index 4016195..0cf62ff 100644 --- a/core/api/src/docs/servicecomposite.txt +++ b/core/api/src/docs/servicecomposite.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/sideeffect.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/sideeffect.txt b/core/api/src/docs/sideeffect.txt index 0f68c28..127ad11 100644 --- a/core/api/src/docs/sideeffect.txt +++ b/core/api/src/docs/sideeffect.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/structure.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/structure.txt b/core/api/src/docs/structure.txt index ac4d81e..50dc7d2 100644 --- a/core/api/src/docs/structure.txt +++ b/core/api/src/docs/structure.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/transientcomposite.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/transientcomposite.txt b/core/api/src/docs/transientcomposite.txt index 1e59731..af05ff1 100644 --- a/core/api/src/docs/transientcomposite.txt +++ b/core/api/src/docs/transientcomposite.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/unitofwork.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/unitofwork.txt b/core/api/src/docs/unitofwork.txt index d8ad3bc..23699d4 100644 --- a/core/api/src/docs/unitofwork.txt +++ b/core/api/src/docs/unitofwork.txt @@ -1,6 +1,4 @@ ////////////////////// - * Copyright (c) 2013, Niclas Hedhman. All Rights Reserved. - * * Licensed 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://git-wip-us.apache.org/repos/asf/zest-java/blob/c24ab017/core/api/src/docs/valuecomposite.txt ---------------------------------------------------------------------- diff --git a/core/api/src/docs/valuecomposite.txt b/core/api/src/docs/valuecomposite.txt index 7aad0c4..8e8a88c 100644 --- a/core/api/src/docs/valuecomposite.txt +++ b/core/api/src/docs/valuecomposite.txt @@ -1,7 +1,4 @@ ////////////////////// - * Copyright (c) 2007-2012, Niclas Hedhman. All Rights Reserved. - * Copyright (c) 2013, Paul Merlin. All Rights Reserved. - * * Licensed 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
